openapi: 3.2.0 info: version: 2.10.0 description: 'Nerve OVDM API to manage: - node configuration - system configuration - system network configuration - workloads - remote connections - dna' title: Nerve Node WORKLOADS SNAPSHOTS API contact: name: Nerve support email: support@tttech-industrial.com security: - cookieAuth: [] tags: - name: WORKLOADS SNAPSHOTS paths: /api/workloads/{deviceId}/snapshots: post: summary: Create snapshot of the selected VM workload operationId: create_vm_snapshot tags: - WORKLOADS SNAPSHOTS x-permissions: - SNAPSHOT:CREATE description: Used to initiate snapshot creation for specified VM workload. parameters: - name: deviceId in: path required: true description: Unique identifier of the deployed workload. Device is a term used for workloads. schema: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 requestBody: required: true description: Object contains the necessary information to create a snapshot of the virtual machine content: application/json: schema: type: object additionalProperties: false description: Object containing data on the snapshot name and description required: - name properties: name: type: string description: The name of the VM workload snapshot pattern: (\s^)|(^[^\u0000-\u001f\u007f-\u009f]*$) minLength: 1 maxLength: 1001 description: type: string description: Snapshot description minLength: 0 maxLength: 1001 pattern: .* examples: vm_snapshot_with_just_name_req: value: name: Snapshot 3-8-2022 14:1:47 GMT+2 vm_snapshot_with_empty_description_req: value: name: Snapshot 3-8-2022 14:1:47 GMT+2 description: '' vm_snapshot_with_description_req: value: name: Snapshot 3-8-2022 14:1:47 GMT+2 description: Some description responses: '202': description: VM snapshot creation was successfully initiated content: application/json: schema: type: object description: Object containing details about created snapshot. required: - name - description - vmState - date additionalProperties: false properties: name: type: string description: The name of the VM workload snapshot pattern: (\s^)|(^[^\u0000-\u001f\u007f-\u009f]*$) minLength: 1 maxLength: 1001 description: type: string description: Snapshot description minLength: 0 maxLength: 1001 pattern: .* vmState: type: string description: In which state vm was in moment when snapshot has been captured enum: - STARTED - STOPPED - SUSPENDED date: type: string description: Date when snapshot was captured (in milliseconds). pattern: ^[0-9]{0,13}$ maxLength: 13 minLength: 0 examples: vm_snapshot_creation: value: name: Snapshot 26-4-2024 23:0:4 GMT+2 description: '' vmState: STARTED date: '1714165204' '400': description: Bad request content: application/json: schema: oneOf: - type: object description: Validation error. required: - status - message - errors additionalProperties: false properties: status: type: integer description: HTTP status code message: type: string minLength: 1 maxLength: 1001 description: The validation error message errors: type: array minItems: 1 maxItems: 1001 description: Detailed description of what does not match the schema items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message - type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '401': description: You are not authorized to perform this operation content: application/json: schema: oneOf: - type: object description: User not authorized required: - user additionalProperties: false properties: user: type: string description: Not authorized enum: - not authorized - type: object description: User not authorized required: - status - msg additionalProperties: false properties: status: type: integer minimum: 401 maximum: 401 description: HTTP status code msg: type: string description: Error message enum: - Not authorized - not authorized - type: object description: Cookie header is missing in the request required: - status - message - errors additionalProperties: false properties: status: description: HTTP status code type: integer enum: - 401 message: type: string description: The validation error message enum: - '''cookie'' header required' errors: type: array minItems: 1 maxItems: 1001 description: List of errors items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message examples: not_authorized_usr: value: user: not authorized not_authorized_status: value: status: 401 msg: Not authorized '403': description: Forbidden content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: forbidden: value: status: 403 msg: Forbidden '404': description: The resource not found content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '500': description: Response received when the response does not match the schema or an unexpected error has occurred. content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* example: status: 500 msg: Invalid response delete: summary: Delete snapshot of the selected VM workload operationId: delete_vm_snapshot tags: - WORKLOADS SNAPSHOTS x-permissions: - SNAPSHOT:DELETE description: Used to delete snapshot of the VM workload parameters: - name: deviceId in: path required: true description: Unique identifier of the deployed workload. Device is a term used for workloads. schema: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 - name: name in: query description: The name of the snapshot to be deleted required: true allowReserved: true schema: type: string description: The name of the VM workload snapshot pattern: (\s^)|(^[^\u0000-\u001f\u007f-\u009f]*$) minLength: 1 maxLength: 1001 responses: '200': description: Message that VM snapshot is deleted content: application/json: schema: type: string description: Message confirming the deletion of the snapshot examples: vm_snapshot_deleted: value: Snapshot deleted '400': description: Bad request content: application/json: schema: oneOf: - type: object description: Validation error. required: - status - message - errors additionalProperties: false properties: status: type: integer description: HTTP status code message: type: string minLength: 1 maxLength: 1001 description: The validation error message errors: type: array minItems: 1 maxItems: 1001 description: Detailed description of what does not match the schema items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message - type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '401': description: You are not authorized to perform this operation content: application/json: schema: oneOf: - type: object description: User not authorized required: - user additionalProperties: false properties: user: type: string description: Not authorized enum: - not authorized - type: object description: User not authorized required: - status - msg additionalProperties: false properties: status: type: integer minimum: 401 maximum: 401 description: HTTP status code msg: type: string description: Error message enum: - Not authorized - not authorized - type: object description: Cookie header is missing in the request required: - status - message - errors additionalProperties: false properties: status: description: HTTP status code type: integer enum: - 401 message: type: string description: The validation error message enum: - '''cookie'' header required' errors: type: array minItems: 1 maxItems: 1001 description: List of errors items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message examples: not_authorized_usr: value: user: not authorized not_authorized_status: value: status: 401 msg: Not authorized '403': description: Forbidden content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: forbidden: value: status: 403 msg: Forbidden '404': description: The resource not found content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '500': description: Response received when the response does not match the schema or an unexpected error has occurred. content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* example: status: 500 msg: Invalid response put: summary: Restore snapshot to the selected VM workload operationId: revert_vm_snapshot tags: - WORKLOADS SNAPSHOTS x-permissions: - SNAPSHOT:REVERT description: Used to initiate the reverting VM workload to specified snapshot parameters: - name: deviceId in: path required: true description: Unique identifier of the deployed workload. Device is a term used for workloads. schema: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 requestBody: required: true description: Object contains name of the snapshot content: application/json: schema: type: object description: Object containing the 'name' property, representing the name of the snapshot to which the VM should be reverted additionalProperties: false required: - name properties: name: type: string description: The name of the VM workload snapshot pattern: (\s^)|(^[^\u0000-\u001f\u007f-\u009f]*$) minLength: 1 maxLength: 1001 examples: vm_snapshot_with_just_name_req: value: name: Snapshot 3-8-2022 14:1:47 GMT+2 responses: '200': description: Reverting the VM to specified snapshot is initiated content: application/json: schema: type: string description: Message confirming the revert action has been initiated examples: vm_snapshot_revert: value: Snapshot applied '400': description: Bad request content: application/json: schema: oneOf: - type: object description: Validation error. required: - status - message - errors additionalProperties: false properties: status: type: integer description: HTTP status code message: type: string minLength: 1 maxLength: 1001 description: The validation error message errors: type: array minItems: 1 maxItems: 1001 description: Detailed description of what does not match the schema items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message - type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '401': description: You are not authorized to perform this operation content: application/json: schema: oneOf: - type: object description: User not authorized required: - user additionalProperties: false properties: user: type: string description: Not authorized enum: - not authorized - type: object description: User not authorized required: - status - msg additionalProperties: false properties: status: type: integer minimum: 401 maximum: 401 description: HTTP status code msg: type: string description: Error message enum: - Not authorized - not authorized - type: object description: Cookie header is missing in the request required: - status - message - errors additionalProperties: false properties: status: description: HTTP status code type: integer enum: - 401 message: type: string description: The validation error message enum: - '''cookie'' header required' errors: type: array minItems: 1 maxItems: 1001 description: List of errors items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message examples: not_authorized_usr: value: user: not authorized not_authorized_status: value: status: 401 msg: Not authorized '403': description: Forbidden content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: forbidden: value: status: 403 msg: Forbidden '404': description: The resource not found content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '500': description: Failed to restore snapshot or the response data does not match the schema. content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: invalid_response: value: status: 500 msg: Invalid response revert_snapshot_failed: value: status: 500 msg: Reverting workload to snapshot failed get: summary: Get snapshots of the selected VM workload operationId: get_vm_snapshots tags: - WORKLOADS SNAPSHOTS x-permissions: - SNAPSHOT:LIST description: Used to obtain the list of VM snapshots as well as the configuration of the schedule snapshot parameters: - name: deviceId in: path required: true description: Unique identifier of the deployed workload. Device is a term used for workloads. schema: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 responses: '200': description: List of VM snapshots and the current setup of the schedule snapshot option content: application/json: schema: type: object description: Object containing the list of VM snapshots and snapshot schedule configuration. required: - snapshots - scheduled additionalProperties: false properties: snapshots: type: array description: List of VM snapshots items: type: object description: Object containing details about created snapshot. required: - name - description - vmState - date additionalProperties: false properties: name: type: string description: The name of the VM workload snapshot pattern: (\s^)|(^[^\u0000-\u001f\u007f-\u009f]*$) minLength: 1 maxLength: 1001 description: type: string description: Snapshot description minLength: 0 maxLength: 1001 pattern: .* vmState: type: string description: In which state vm was in moment when snapshot has been captured enum: - STARTED - STOPPED - SUSPENDED date: type: string description: Date when snapshot was captured (in milliseconds). pattern: ^[0-9]{0,13}$ maxLength: 13 minLength: 0 minItems: 0 maxItems: 1001 scheduled: type: - object - 'null' description: Object containing the current schedule configuration, or NULL if no configuration is set oneOf: - type: - object - 'null' additionalProperties: false - type: object description: Object containing information if and how creation of snapshots is or should be scheduled additionalProperties: false required: - type - intervalTime - day - dayTime - dayHours - dayMinutes - vmState - timeZone - timezoneOffset properties: type: type: string description: Type of schedule enum: - Interval - Day intervalTime: type: integer description: Interval in hours minimum: 1 maximum: 9999 day: oneOf: - type: string description: Day of the week enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday - Every day - type: string description: Empty string enum: - '' minLength: 0 maxLength: 0 pattern: ^$ dayTime: oneOf: - type: string description: Time of day when snapshot will be created minLength: 0 maxLength: 5 pattern: ^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$ - type: string description: Empty string enum: - '' minLength: 0 maxLength: 0 pattern: ^$ dayHours: type: integer description: Hour at which snapshot will be created minimum: 0 maximum: 23 dayMinutes: type: integer description: Minute of the hour at which snapshot will be created minimum: 0 maximum: 59 vmState: type: string description: State in which VM should be when snapshot is captured enum: - Current - Stopped timeZone: type: string description: The name of the timezone minLength: 0 maxLength: 1001 pattern: ^[A-Za-z]+\/[A-Za-z_]+$ timezoneOffset: type: string pattern: ^[+-]*[\d]+$ description: Timezone offset minLength: 0 maxLength: 1001 serialNumber: description: The serial number of the node type: string maxLength: 12 minLength: 12 pattern: ([A-Z0-9]){12} deviceId: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 initiator: type: object description: Who initiated the snapshot operation - returned when schedule is initiated from cloud properties: firstName: type: string description: User first name lastName: type: string description: User last name username: type: string description: Username of the user examples: get_snapshots_no_schedule: value: snapshots: - name: Snapshot 26-4-2024 23:20:1 GMT+2 description: '' vmState: STARTED date: '1714166401' scheduled: null get_snapshots_schedule_day: value: snapshots: - name: Snapshot 26-4-2024 23:20:1 GMT+2 description: '' vmState: STARTED date: '1714166401' scheduled: type: Day intervalTime: 1 day: Monday dayTime: '1:01' dayHours: 1 dayMinutes: 1 vmState: Current timeZone: Europe/Belgrade timezoneOffset: '+2' get_snapshots_schedule_interval: value: snapshots: - name: Snapshot 26-4-2024 23:20:1 GMT+2 description: '' vmState: STARTED date: '1714166401' scheduled: type: Interval intervalTime: 1 day: Monday dayTime: '' dayHours: 1 dayMinutes: 1 vmState: Current timeZone: Europe/Belgrade timezoneOffset: '+2' '400': description: Bad request content: application/json: schema: oneOf: - type: object description: Validation error. required: - status - message - errors additionalProperties: false properties: status: type: integer description: HTTP status code message: type: string minLength: 1 maxLength: 1001 description: The validation error message errors: type: array minItems: 1 maxItems: 1001 description: Detailed description of what does not match the schema items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message - type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '401': description: You are not authorized to perform this operation content: application/json: schema: oneOf: - type: object description: User not authorized required: - user additionalProperties: false properties: user: type: string description: Not authorized enum: - not authorized - type: object description: User not authorized required: - status - msg additionalProperties: false properties: status: type: integer minimum: 401 maximum: 401 description: HTTP status code msg: type: string description: Error message enum: - Not authorized - not authorized - type: object description: Cookie header is missing in the request required: - status - message - errors additionalProperties: false properties: status: description: HTTP status code type: integer enum: - 401 message: type: string description: The validation error message enum: - '''cookie'' header required' errors: type: array minItems: 1 maxItems: 1001 description: List of errors items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message examples: not_authorized_usr: value: user: not authorized not_authorized_status: value: status: 401 msg: Not authorized '403': description: Forbidden content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: forbidden: value: status: 403 msg: Forbidden '404': description: The resource not found content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '500': description: Response received when the response does not match the schema or an unexpected error has occurred. content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* example: status: 500 msg: Invalid response /api/workloads/{deviceId}/snapshots/schedule: delete: summary: Delete snapshot scheduled of the selected VM workload operationId: delete_vm_schedule_snapshot_config tags: - WORKLOADS SNAPSHOTS x-permissions: - SNAPSHOT_SCHEDULE:DELETE description: Used to delete the snapshot schedule parameters: - name: deviceId in: path required: true description: Unique identifier of the deployed workload. Device is a term used for workloads. schema: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 responses: '200': description: Schedule snapshot configuration successfully deleted content: application/json: schema: type: string description: Message confirming the delation of the schedule configuration examples: vm_scheduled_snapshot: value: Scheduled snapshot deleted '400': description: Bad request content: application/json: schema: oneOf: - type: object description: Validation error. required: - status - message - errors additionalProperties: false properties: status: type: integer description: HTTP status code message: type: string minLength: 1 maxLength: 1001 description: The validation error message errors: type: array minItems: 1 maxItems: 1001 description: Detailed description of what does not match the schema items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message - type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '401': description: You are not authorized to perform this operation content: application/json: schema: oneOf: - type: object description: User not authorized required: - user additionalProperties: false properties: user: type: string description: Not authorized enum: - not authorized - type: object description: User not authorized required: - status - msg additionalProperties: false properties: status: type: integer minimum: 401 maximum: 401 description: HTTP status code msg: type: string description: Error message enum: - Not authorized - not authorized - type: object description: Cookie header is missing in the request required: - status - message - errors additionalProperties: false properties: status: description: HTTP status code type: integer enum: - 401 message: type: string description: The validation error message enum: - '''cookie'' header required' errors: type: array minItems: 1 maxItems: 1001 description: List of errors items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message examples: not_authorized_usr: value: user: not authorized not_authorized_status: value: status: 401 msg: Not authorized '403': description: Forbidden content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: forbidden: value: status: 403 msg: Forbidden '404': description: The resource not found content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '500': description: Response received when the response does not match the schema or an unexpected error has occurred. content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* example: status: 500 msg: Invalid response post: summary: Create a snapshot schedule for the selected VM workload operationId: create_vm_schedule_snapshot_config tags: - WORKLOADS SNAPSHOTS x-permissions: - SNAPSHOT_SCHEDULE:CREATE description: Used to create a snapshot schedule parameters: - name: deviceId in: path required: true description: Unique identifier of the deployed workload. Device is a term used for workloads. schema: type: string description: Id of the deployed workload pattern: ^\d+$ minLength: 1 maxLength: 1001 requestBody: required: true content: application/json: schema: type: object description: Object containing information if and how creation of snapshots is or should be scheduled additionalProperties: false required: - type - intervalTime - day - dayTime - dayHours - dayMinutes - vmState - timeZone - timezoneOffset properties: type: type: string description: Type of schedule enum: - Interval - Day intervalTime: type: integer description: Interval in hours minimum: 1 maximum: 9999 day: oneOf: - type: string description: Day of the week enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday - Every day - type: string description: Empty string enum: - '' minLength: 0 maxLength: 0 pattern: ^$ dayTime: oneOf: - type: string description: Time of day when snapshot will be created minLength: 0 maxLength: 5 pattern: ^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$ - type: string description: Empty string enum: - '' minLength: 0 maxLength: 0 pattern: ^$ dayHours: type: integer description: Hour at which snapshot will be created minimum: 0 maximum: 23 dayMinutes: type: integer description: Minute of the hour at which snapshot will be created minimum: 0 maximum: 59 vmState: type: string description: State in which VM should be when snapshot is captured enum: - Current - Stopped timeZone: type: string description: The name of the timezone minLength: 0 maxLength: 1001 pattern: ^[A-Za-z]+\/[A-Za-z_]+$ timezoneOffset: type: string pattern: ^[+-]*[\d]+$ description: Timezone offset minLength: 0 maxLength: 1001 examples: vm_schedule_snapshot_config: value: type: Day intervalTime: 1 day: Friday dayTime: 06:15 dayHours: 1 dayMinutes: 1 vmState: Stopped timeZone: Europe/Belgrade timezoneOffset: '+2' responses: '201': description: Schedule snapshot creation successfully setup content: application/json: schema: type: string description: Message confirming the creation of the schedule configuration examples: vm_scheduled_snapshot: value: Snapshot creation scheduled '400': description: Bad request content: application/json: schema: oneOf: - type: object description: Validation error. required: - status - message - errors additionalProperties: false properties: status: type: integer description: HTTP status code message: type: string minLength: 1 maxLength: 1001 description: The validation error message errors: type: array minItems: 1 maxItems: 1001 description: Detailed description of what does not match the schema items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message - type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '401': description: You are not authorized to perform this operation content: application/json: schema: oneOf: - type: object description: User not authorized required: - user additionalProperties: false properties: user: type: string description: Not authorized enum: - not authorized - type: object description: User not authorized required: - status - msg additionalProperties: false properties: status: type: integer minimum: 401 maximum: 401 description: HTTP status code msg: type: string description: Error message enum: - Not authorized - not authorized - type: object description: Cookie header is missing in the request required: - status - message - errors additionalProperties: false properties: status: description: HTTP status code type: integer enum: - 401 message: type: string description: The validation error message enum: - '''cookie'' header required' errors: type: array minItems: 1 maxItems: 1001 description: List of errors items: type: object properties: path: type: string minLength: 1 maxLength: 1001 description: Specified location within the document where the error occurred message: type: string minLength: 1 maxLength: 1001 description: Error message examples: not_authorized_usr: value: user: not authorized not_authorized_status: value: status: 401 msg: Not authorized '403': description: Forbidden content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* examples: forbidden: value: status: 403 msg: Forbidden '404': description: The resource not found content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* '500': description: Response received when the response does not match the schema or an unexpected error has occurred. content: application/json: schema: type: object description: Description of error associated with status code. required: - status - msg additionalProperties: false properties: status: type: integer description: HTTP status code msg: type: string minLength: 1 maxLength: 1001 description: Error message pattern: .* example: status: 500 msg: Invalid response components: securitySchemes: cookieAuth: type: apiKey in: header name: cookie basicAuth: type: http scheme: basic