# Code generated from hashicorp/nomad-openapi/generator; DO NOT EDIT. components: parameters: ACLPolicyNameParam: description: The ACL policy name. in: path name: policyName required: true schema: type: string ACLTokenAccessorParam: description: The token accessor ID. in: path name: tokenAccessor required: true schema: type: string AllParam: description: Flag indicating whether to constrain by job creation index or not. in: query name: all schema: type: integer AllocIDParam: description: Allocation ID. in: path name: allocID required: true schema: type: string AllocNoShutdownDelayParam: description: Flag indicating whether to delay shutdown when requesting an allocation stop. in: query name: no_shutdown_delay schema: type: boolean AllocationResourcesParam: description: Flag indicating whether to include resources in response. in: query name: resources schema: type: boolean AllocationsTasksStatesParam: description: Flag indicating whether to include task states in response. in: query name: task_states schema: type: boolean DeploymentIDParam: description: Deployment ID. in: path name: deploymentID required: true schema: type: string EvalIDParam: description: Evaluation ID. in: path name: evalID required: true schema: type: string IdempotencyTokenParam: description: Can be used to ensure operations are only run once. in: query name: idempotency_token schema: type: string IndexHeader: description: If set, wait until query exceeds given index. Must be provided with WaitParam. in: header name: index schema: type: integer JobAllocationsParam: description: Specifies whether the list of allocations should include allocations from a previously registered job with the same ID. This is possible if the job is deregistered and reregistered. in: query name: all schema: type: boolean JobDiffsParam: description: Boolean flag indicating whether to compute job diffs. in: query name: diffs schema: type: boolean JobGlobalParam: description: Boolean flag indicating whether the operation should apply to all instances of the job globally. in: query name: global schema: type: boolean JobNameParam: description: The job identifier. in: path name: jobName required: true schema: type: string JobPurgeParam: description: Boolean flag indicating whether to purge allocations of the job after deleting. in: query name: purge schema: type: boolean MetricsFormatParam: description: The format the user requested for the metrics summary (e.g. prometheus) in: query name: format schema: type: string NamespaceNameParam: description: The namespace identifier. in: path name: namespaceName required: true schema: type: string NamespaceParam: description: Filters results based on the specified namespace. in: query name: namespace schema: type: string NextTokenParam: description: Indicates where to start paging for queries that support pagination. in: query name: next_token schema: type: string NodeIdParam: description: The ID of the node. in: path name: nodeId required: true schema: type: string NodeResourcesParam: description: Whether or not to include the NodeResources and ReservedResources fields in the response. in: query name: resources schema: type: boolean NomadTokenHeader: description: A Nomad ACL token. in: header name: X-Nomad-Token schema: type: string PerPageParam: description: Maximum number of results to return. in: query name: per_page schema: type: integer PluginIDParam: description: The CSI plugin identifier. in: path name: pluginID required: true schema: type: string PrefixParam: description: Constrains results to jobs that start with the defined prefix in: query name: prefix schema: type: string QuotaSpecNameParam: description: The quota spec identifier. in: path name: specName required: true schema: type: string RegionParam: description: Filters results based on the specified region. in: query name: region schema: type: string ScalingPolicyIDParam: description: The scaling policy identifier. in: path name: policyID required: true schema: type: string SnapshotIDParam: description: The ID of the snapshot to target. in: query name: snapshot_id schema: type: string StaleParam: description: If present, results will include stale reads. in: query name: stale schema: type: string VariableCAS: description: A compare-and-set parameter for Nomad Variables in: query name: cas schema: type: integer VariablePath: description: A path to a Nomad Variable in: path name: path required: true schema: type: string VolumeActionParam: description: The action to perform on the Volume (create, detach, delete). in: path name: action required: true schema: type: string VolumeForceParam: description: Used to force the de-registration of a volume. in: query name: force schema: type: string VolumeIDParam: description: Volume unique identifier. in: path name: volumeId required: true schema: type: string VolumeNodeIDParam: description: Filters volume lists by node ID. in: query name: node_id schema: type: string VolumeNodeParam: description: Specifies node to target volume operation for. in: query name: node schema: type: string VolumePluginIDParam: description: Filters volume lists by plugin ID. in: query name: plugin_id schema: type: string VolumeTypeParam: description: Filters volume lists to a specific type. in: query name: type schema: type: string WaitParam: description: Provided with IndexParam to wait for change. in: query name: wait schema: type: string requestBodies: ACLPolicy: content: application/json: schema: $ref: '#/components/schemas/ACLPolicy' required: true ACLToken: content: application/json: schema: $ref: '#/components/schemas/ACLToken' required: true AutopilotConfiguration: content: application/json: schema: $ref: '#/components/schemas/AutopilotConfiguration' required: true CSISnapshotCreateRequest: content: application/json: schema: $ref: '#/components/schemas/CSISnapshotCreateRequest' required: true CSIVolumeCreateRequest: content: application/json: schema: $ref: '#/components/schemas/CSIVolumeCreateRequest' required: true CSIVolumeRegisterRequest: content: application/json: schema: $ref: '#/components/schemas/CSIVolumeRegisterRequest' required: true DeploymentAllocHealthRequest: content: application/json: schema: $ref: '#/components/schemas/DeploymentAllocHealthRequest' required: true DeploymentPauseRequest: content: application/json: schema: $ref: '#/components/schemas/DeploymentPauseRequest' required: true DeploymentPromoteRequest: content: application/json: schema: $ref: '#/components/schemas/DeploymentPromoteRequest' required: true DeploymentUnblockRequest: content: application/json: schema: $ref: '#/components/schemas/DeploymentUnblockRequest' required: true FuzzySearchRequest: content: application/json: schema: $ref: '#/components/schemas/FuzzySearchRequest' required: true JobDispatchRequest: content: application/json: schema: $ref: '#/components/schemas/JobDispatchRequest' required: true JobEvaluateRequest: content: application/json: schema: $ref: '#/components/schemas/JobEvaluateRequest' required: true JobPlanRequest: content: application/json: schema: $ref: '#/components/schemas/JobPlanRequest' required: true JobRegisterRequest: content: application/json: schema: $ref: '#/components/schemas/JobRegisterRequest' required: true JobRevertRequest: content: application/json: schema: $ref: '#/components/schemas/JobRevertRequest' required: true JobStabilityRequest: content: application/json: schema: $ref: '#/components/schemas/JobStabilityRequest' required: true JobValidateRequest: content: application/json: schema: $ref: '#/components/schemas/JobValidateRequest' required: true JobsParseRequest: content: application/json: schema: $ref: '#/components/schemas/JobsParseRequest' required: true Namespace: content: application/json: schema: $ref: '#/components/schemas/Namespace' required: true NodeUpdateDrainRequest: content: application/json: schema: $ref: '#/components/schemas/NodeUpdateDrainRequest' required: true NodeUpdateEligibilityRequest: content: application/json: schema: $ref: '#/components/schemas/NodeUpdateEligibilityRequest' required: true OneTimeTokenExchangeRequest: content: application/json: schema: $ref: '#/components/schemas/OneTimeTokenExchangeRequest' required: true QuotaSpec: content: application/json: schema: $ref: '#/components/schemas/QuotaSpec' required: true ScalingRequest: content: application/json: schema: $ref: '#/components/schemas/ScalingRequest' required: true SchedulerConfiguration: content: application/json: schema: $ref: '#/components/schemas/SchedulerConfiguration' required: true SearchRequest: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' required: true Variable: content: application/json: schema: $ref: '#/components/schemas/Variable' required: true responses: BadRequestResponse: description: Bad request CreateNamespaceResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer CreateQuotaSpecResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteACLPolicyResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteACLTokenResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteJobResponse: content: application/json: schema: $ref: '#/components/schemas/JobDeregisterResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteNamespaceResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteOperatorRaftPeerResponse: description: "" DeleteSnapshotResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteVariableResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DeleteVolumeRegistrationResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer DetachOrDeleteVolumeResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer ForbiddenResponse: description: Forbidden GetACLPoliciesResponse: content: application/json: schema: items: $ref: '#/components/schemas/ACLPolicyListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetACLPolicyResponse: content: application/json: schema: $ref: '#/components/schemas/ACLPolicy' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetACLTokenResponse: content: application/json: schema: $ref: '#/components/schemas/ACLToken' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetACLTokenSelfResponse: content: application/json: schema: $ref: '#/components/schemas/ACLToken' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetACLTokensResponse: content: application/json: schema: items: $ref: '#/components/schemas/ACLTokenListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetAllocationResponse: content: application/json: schema: $ref: '#/components/schemas/Allocation' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetAllocationServicesResponse: content: application/json: schema: items: $ref: '#/components/schemas/ServiceRegistration' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetAllocationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/AllocationListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetDeploymentAllocationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/AllocationListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetDeploymentResponse: content: application/json: schema: $ref: '#/components/schemas/Deployment' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetDeploymentsResponse: content: application/json: schema: items: $ref: '#/components/schemas/Deployment' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetEvaluationAllocationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/AllocationListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetEvaluationResponse: content: application/json: schema: $ref: '#/components/schemas/Evaluation' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetEvaluationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/Evaluation' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetExternalVolumesResponse: content: application/json: schema: $ref: '#/components/schemas/CSIVolumeListExternalResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetFuzzySearchResponse: content: application/json: schema: $ref: '#/components/schemas/FuzzySearchResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobAllocationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/AllocationListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobDeploymentResponse: content: application/json: schema: $ref: '#/components/schemas/Deployment' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobDeploymentsResponse: content: application/json: schema: items: $ref: '#/components/schemas/Deployment' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobEvaluationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/Evaluation' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobResponse: content: application/json: schema: $ref: '#/components/schemas/Job' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobScaleStatusResponse: content: application/json: schema: $ref: '#/components/schemas/JobScaleStatusResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobSummaryResponse: content: application/json: schema: $ref: '#/components/schemas/JobSummary' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobVersionsResponse: content: application/json: schema: $ref: '#/components/schemas/JobVersionsResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetJobsResponse: content: application/json: schema: items: $ref: '#/components/schemas/JobListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetMetricsSummaryResponse: content: application/json: schema: $ref: '#/components/schemas/MetricsSummary' description: "" GetNamespaceResponse: content: application/json: schema: $ref: '#/components/schemas/Namespace' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetNamespacesResponse: content: application/json: schema: items: $ref: '#/components/schemas/Namespace' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetNodeAllocationsResponse: content: application/json: schema: items: $ref: '#/components/schemas/AllocationListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetNodeResponse: content: application/json: schema: $ref: '#/components/schemas/Node' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetNodesResponse: content: application/json: schema: items: $ref: '#/components/schemas/NodeListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetOperatorAutopilotConfigurationResponse: content: application/json: schema: $ref: '#/components/schemas/AutopilotConfiguration' description: "" GetOperatorAutopilotHealthResponse: content: application/json: schema: $ref: '#/components/schemas/OperatorHealthReply' description: "" GetOperatorRaftConfigurationResponse: content: application/json: schema: $ref: '#/components/schemas/RaftConfiguration' description: "" GetOperatorSchedulerConfigurationResponse: content: application/json: schema: $ref: '#/components/schemas/SchedulerConfigurationResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetPluginCSIResponse: content: application/json: schema: items: $ref: '#/components/schemas/CSIPlugin' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetPluginsResponse: content: application/json: schema: items: $ref: '#/components/schemas/CSIPluginListStub' type: array description: "" GetQuotaSpecResponse: content: application/json: schema: $ref: '#/components/schemas/QuotaSpec' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetQuotasResponse: content: application/json: schema: items: {} type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetRegionsResponse: content: application/json: schema: items: type: string type: array description: "" GetScalingPoliciesResponse: content: application/json: schema: items: $ref: '#/components/schemas/ScalingPolicyListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetScalingPolicyResponse: content: application/json: schema: $ref: '#/components/schemas/ScalingPolicy' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetSearchResponse: content: application/json: schema: $ref: '#/components/schemas/SearchResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetSnapshotsResponse: content: application/json: schema: $ref: '#/components/schemas/CSISnapshotListResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetStatusLeaderResponse: content: application/json: schema: type: string description: "" GetStatusPeersResponse: content: application/json: schema: items: type: string type: array description: "" GetVariableResponse: content: application/json: schema: $ref: '#/components/schemas/Variable' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetVariablesListResponse: content: application/json: schema: items: $ref: '#/components/schemas/VariableMetadata' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetVolumeResponse: content: application/json: schema: $ref: '#/components/schemas/CSIVolume' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer GetVolumesResponse: content: application/json: schema: items: $ref: '#/components/schemas/CSIVolumeListStub' type: array description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer InternalServerErrorResponse: description: Internal server error MethodNotAllowedResponse: description: Method not allowed NodeDrainUpdateResponse: content: application/json: schema: $ref: '#/components/schemas/NodeDrainUpdateResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer NodeEligibilityUpdateResponse: content: application/json: schema: $ref: '#/components/schemas/NodeEligibilityUpdateResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer NodePurgeResponse: content: application/json: schema: $ref: '#/components/schemas/NodePurgeResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostACLBootstrapResponse: content: application/json: schema: $ref: '#/components/schemas/ACLToken' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostACLPolicyResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostACLTokenOnetimeExchangeResponse: content: application/json: schema: $ref: '#/components/schemas/ACLToken' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostACLTokenOnetimeResponse: content: application/json: schema: $ref: '#/components/schemas/OneTimeToken' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostACLTokenResponse: content: application/json: schema: $ref: '#/components/schemas/ACLToken' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostAllocationStopResponse: content: application/json: schema: $ref: '#/components/schemas/AllocStopResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostDeploymentAllocationHealthResponse: content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' description: "" PostDeploymentFailResponse: content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' description: "" PostDeploymentPauseResponse: content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' description: "" PostDeploymentPromoteResponse: content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' description: "" PostDeploymentUnblockResponse: content: application/json: schema: $ref: '#/components/schemas/DeploymentUpdateResponse' description: "" PostJobDispatchResponse: content: application/json: schema: $ref: '#/components/schemas/JobDispatchResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobEvaluateResponse: content: application/json: schema: $ref: '#/components/schemas/JobRegisterResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobParseResponse: content: application/json: schema: $ref: '#/components/schemas/Job' description: "" PostJobPeriodicForceResponse: content: application/json: schema: $ref: '#/components/schemas/PeriodicForceResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobPlanResponse: content: application/json: schema: $ref: '#/components/schemas/JobPlanResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobResponse: content: application/json: schema: $ref: '#/components/schemas/JobRegisterResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer PostJobRevertResponse: content: application/json: schema: $ref: '#/components/schemas/JobRegisterResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobScalingResponse: content: application/json: schema: $ref: '#/components/schemas/JobRegisterResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobStabilityResponse: content: application/json: schema: $ref: '#/components/schemas/JobStabilityResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostJobValidateResponse: content: application/json: schema: $ref: '#/components/schemas/JobValidateResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostNamespaceResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostOperatorSchedulerConfigurationResponse: content: application/json: schema: $ref: '#/components/schemas/SchedulerSetConfigurationResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostQuotaSpecResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostSnapshotResponse: content: application/json: schema: $ref: '#/components/schemas/CSISnapshotCreateResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostVariableResponse: content: application/json: schema: $ref: '#/components/schemas/Variable' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostVolumeRegistrationResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer PostVolumeResponse: description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer PutOperatorAutopilotConfigurationResponse: content: application/json: schema: type: boolean description: "" PutSystemGCResponse: description: "" PutSystemReconcileSummariesResponse: description: "" PutVariableResponse: content: application/json: schema: $ref: '#/components/schemas/Variable' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer RegisterJobResponse: content: application/json: schema: $ref: '#/components/schemas/JobRegisterResponse' description: "" headers: X-Nomad-Index: description: A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. schema: type: integer X-Nomad-KnownLeader: description: Boolean indicating if there is a known cluster leader. schema: type: boolean X-Nomad-LastContact: description: The time in milliseconds that a server was last contacted by the leader node. schema: type: integer default: description: "" schemas: ACLPolicy: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Description: type: string JobACL: $ref: '#/components/schemas/JobACL' ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string Rules: type: string type: object ACLPolicyListStub: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Description: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string type: object ACLToken: properties: AccessorID: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: date-time type: string ExpirationTTL: format: int64 type: integer ExpirationTime: format: date-time type: string Global: type: boolean ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string Policies: items: type: string type: array Roles: items: $ref: '#/components/schemas/ACLTokenRoleLink' type: array SecretID: type: string Type: type: string type: object ACLTokenListStub: properties: AccessorID: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: date-time type: string Global: type: boolean ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string Policies: items: type: string type: array Roles: items: $ref: '#/components/schemas/ACLTokenRoleLink' type: array Type: type: string expiration_time: format: date-time type: string type: object ACLTokenRoleLink: properties: ID: type: string Name: type: string type: object Affinity: properties: LTarget: type: string Operand: type: string RTarget: type: string Weight: maximum: 127 minimum: -128 type: integer type: object AllocDeploymentStatus: properties: Canary: type: boolean Healthy: type: boolean ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Timestamp: format: date-time type: string type: object AllocStopResponse: properties: EvalID: type: string Index: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object AllocatedCpuResources: properties: CpuShares: format: int64 type: integer type: object AllocatedDeviceResource: properties: DeviceIDs: items: type: string type: array Name: type: string Type: type: string Vendor: type: string type: object AllocatedMemoryResources: properties: MemoryMB: format: int64 type: integer MemoryMaxMB: format: int64 type: integer type: object AllocatedResources: properties: Shared: $ref: '#/components/schemas/AllocatedSharedResources' Tasks: additionalProperties: $ref: '#/components/schemas/AllocatedTaskResources' type: object type: object AllocatedSharedResources: properties: DiskMB: format: int64 type: integer Networks: items: $ref: '#/components/schemas/NetworkResource' type: array Ports: items: $ref: '#/components/schemas/PortMapping' type: array type: object AllocatedTaskResources: properties: Cpu: $ref: '#/components/schemas/AllocatedCpuResources' Devices: items: $ref: '#/components/schemas/AllocatedDeviceResource' type: array Memory: $ref: '#/components/schemas/AllocatedMemoryResources' Networks: items: $ref: '#/components/schemas/NetworkResource' type: array type: object Allocation: properties: AllocModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer AllocatedResources: $ref: '#/components/schemas/AllocatedResources' ClientDescription: type: string ClientStatus: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: int64 type: integer DeploymentID: type: string DeploymentStatus: $ref: '#/components/schemas/AllocDeploymentStatus' DesiredDescription: type: string DesiredStatus: type: string DesiredTransition: $ref: '#/components/schemas/DesiredTransition' EvalID: type: string FollowupEvalID: type: string ID: type: string Job: $ref: '#/components/schemas/Job' JobID: type: string Metrics: $ref: '#/components/schemas/AllocationMetric' ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyTime: format: int64 type: integer Name: type: string Namespace: type: string NextAllocation: type: string NodeID: type: string NodeName: type: string PreemptedAllocations: items: type: string type: array PreemptedByAllocation: type: string PreviousAllocation: type: string RescheduleTracker: $ref: '#/components/schemas/RescheduleTracker' Resources: $ref: '#/components/schemas/Resources' Services: additionalProperties: type: string type: object TaskGroup: type: string TaskResources: additionalProperties: $ref: '#/components/schemas/Resources' type: object TaskStates: additionalProperties: $ref: '#/components/schemas/TaskState' type: object type: object AllocationListStub: properties: AllocatedResources: $ref: '#/components/schemas/AllocatedResources' ClientDescription: type: string ClientStatus: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: int64 type: integer DeploymentStatus: $ref: '#/components/schemas/AllocDeploymentStatus' DesiredDescription: type: string DesiredStatus: type: string EvalID: type: string FollowupEvalID: type: string ID: type: string JobID: type: string JobType: type: string JobVersion: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyTime: format: int64 type: integer Name: type: string Namespace: type: string NodeID: type: string NodeName: type: string PreemptedAllocations: items: type: string type: array PreemptedByAllocation: type: string RescheduleTracker: $ref: '#/components/schemas/RescheduleTracker' TaskGroup: type: string TaskStates: additionalProperties: $ref: '#/components/schemas/TaskState' type: object type: object AllocationMetric: properties: AllocationTime: format: int64 type: integer ClassExhausted: additionalProperties: type: integer type: object ClassFiltered: additionalProperties: type: integer type: object CoalescedFailures: type: integer ConstraintFiltered: additionalProperties: type: integer type: object DimensionExhausted: additionalProperties: type: integer type: object NodesAvailable: additionalProperties: type: integer type: object NodesEvaluated: type: integer NodesExhausted: type: integer NodesFiltered: type: integer QuotaExhausted: items: type: string type: array ResourcesExhausted: additionalProperties: $ref: '#/components/schemas/Resources' type: object ScoreMetaData: items: $ref: '#/components/schemas/NodeScoreMeta' type: array Scores: additionalProperties: format: double type: number type: object type: object Attribute: properties: Bool: type: boolean Float: format: double type: number Int: format: int64 type: integer String: type: string Unit: type: string type: object AutopilotConfiguration: properties: CleanupDeadServers: type: boolean CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer DisableUpgradeMigration: type: boolean EnableCustomUpgrades: type: boolean EnableRedundancyZones: type: boolean LastContactThreshold: type: string MaxTrailingLogs: maximum: 1.8446744073709552e+19 minimum: 0 type: integer MinQuorum: minimum: 0 type: integer ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ServerStabilizationTime: type: string type: object CSIControllerInfo: properties: SupportsAttachDetach: type: boolean SupportsClone: type: boolean SupportsCondition: type: boolean SupportsCreateDelete: type: boolean SupportsCreateDeleteSnapshot: type: boolean SupportsExpand: type: boolean SupportsGet: type: boolean SupportsGetCapacity: type: boolean SupportsListSnapshots: type: boolean SupportsListVolumes: type: boolean SupportsListVolumesAttachedNodes: type: boolean SupportsReadOnlyAttach: type: boolean type: object CSIInfo: properties: AllocID: type: string ControllerInfo: $ref: '#/components/schemas/CSIControllerInfo' HealthDescription: type: string Healthy: type: boolean NodeInfo: $ref: '#/components/schemas/CSINodeInfo' PluginID: type: string RequiresControllerPlugin: type: boolean RequiresTopologies: type: boolean UpdateTime: format: date-time type: string type: object CSIMountOptions: properties: FSType: type: string MountFlags: items: type: string type: array type: object CSINodeInfo: properties: AccessibleTopology: $ref: '#/components/schemas/CSITopology' ID: type: string MaxVolumes: format: int64 type: integer RequiresNodeStageVolume: type: boolean SupportsCondition: type: boolean SupportsExpand: type: boolean SupportsStats: type: boolean type: object CSIPlugin: properties: Allocations: items: $ref: '#/components/schemas/AllocationListStub' type: array ControllerRequired: type: boolean Controllers: additionalProperties: $ref: '#/components/schemas/CSIInfo' type: object ControllersExpected: type: integer ControllersHealthy: type: integer CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Nodes: additionalProperties: $ref: '#/components/schemas/CSIInfo' type: object NodesExpected: type: integer NodesHealthy: type: integer Provider: type: string Version: type: string type: object CSIPluginListStub: properties: ControllerRequired: type: boolean ControllersExpected: type: integer ControllersHealthy: type: integer CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NodesExpected: type: integer NodesHealthy: type: integer Provider: type: string type: object CSIPluginType: type: string CSISecrets: additionalProperties: type: string type: object CSISnapshot: properties: CreateTime: format: int64 type: integer ExternalSourceVolumeID: type: string ID: type: string IsReady: type: boolean Name: type: string Parameters: additionalProperties: type: string type: object PluginID: type: string Secrets: $ref: '#/components/schemas/CSISecrets' SizeBytes: format: int64 type: integer SourceVolumeID: type: string type: object CSISnapshotCreateRequest: properties: Namespace: type: string Region: type: string SecretID: type: string Snapshots: items: $ref: '#/components/schemas/CSISnapshot' type: array type: object CSISnapshotCreateResponse: properties: KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextToken: type: string RequestTime: format: int64 type: integer Snapshots: items: $ref: '#/components/schemas/CSISnapshot' type: array type: object CSISnapshotListResponse: properties: KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextToken: type: string RequestTime: format: int64 type: integer Snapshots: items: $ref: '#/components/schemas/CSISnapshot' type: array type: object CSITopology: properties: Segments: additionalProperties: type: string type: object type: object CSITopologyRequest: properties: Preferred: items: $ref: '#/components/schemas/CSITopology' type: array Required: items: $ref: '#/components/schemas/CSITopology' type: array type: object CSIVolume: properties: AccessMode: type: string Allocations: items: $ref: '#/components/schemas/AllocationListStub' type: array AttachmentMode: type: string Capacity: format: int64 type: integer CloneID: type: string Context: additionalProperties: type: string type: object ControllerRequired: type: boolean ControllersExpected: type: integer ControllersHealthy: type: integer CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ExternalID: type: string ID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer MountOptions: $ref: '#/components/schemas/CSIMountOptions' Name: type: string Namespace: type: string NodesExpected: type: integer NodesHealthy: type: integer Parameters: additionalProperties: type: string type: object PluginID: type: string Provider: type: string ProviderVersion: type: string ReadAllocs: additionalProperties: $ref: '#/components/schemas/Allocation' type: object RequestedCapabilities: items: $ref: '#/components/schemas/CSIVolumeCapability' type: array RequestedCapacityMax: format: int64 type: integer RequestedCapacityMin: format: int64 type: integer RequestedTopologies: $ref: '#/components/schemas/CSITopologyRequest' ResourceExhausted: format: date-time type: string Schedulable: type: boolean Secrets: $ref: '#/components/schemas/CSISecrets' SnapshotID: type: string Topologies: items: $ref: '#/components/schemas/CSITopology' type: array WriteAllocs: additionalProperties: $ref: '#/components/schemas/Allocation' type: object type: object CSIVolumeAccessMode: type: string CSIVolumeAttachmentMode: type: string CSIVolumeCapability: properties: AccessMode: type: string AttachmentMode: type: string type: object CSIVolumeCreateRequest: properties: Namespace: type: string Region: type: string SecretID: type: string Volumes: items: $ref: '#/components/schemas/CSIVolume' type: array type: object CSIVolumeExternalStub: properties: CapacityBytes: format: int64 type: integer CloneID: type: string ExternalID: type: string IsAbnormal: type: boolean PublishedExternalNodeIDs: items: type: string type: array SnapshotID: type: string Status: type: string VolumeContext: additionalProperties: type: string type: object type: object CSIVolumeListExternalResponse: properties: NextToken: type: string Volumes: items: $ref: '#/components/schemas/CSIVolumeExternalStub' type: array type: object CSIVolumeListStub: properties: AccessMode: type: string AttachmentMode: type: string ControllerRequired: type: boolean ControllersExpected: type: integer ControllersHealthy: type: integer CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CurrentReaders: type: integer CurrentWriters: type: integer ExternalID: type: string ID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string Namespace: type: string NodesExpected: type: integer NodesHealthy: type: integer PluginID: type: string Provider: type: string ResourceExhausted: format: date-time type: string Schedulable: type: boolean Topologies: items: $ref: '#/components/schemas/CSITopology' type: array type: object CSIVolumeRegisterRequest: properties: Namespace: type: string Region: type: string SecretID: type: string Volumes: items: $ref: '#/components/schemas/CSIVolume' type: array type: object ChangeScript: properties: Args: items: type: string type: array Command: type: string FailOnError: type: boolean Timeout: format: int64 type: integer type: object CheckRestart: properties: Grace: format: int64 type: integer IgnoreWarnings: type: boolean Limit: type: integer type: object Constraint: properties: LTarget: type: string Operand: type: string RTarget: type: string type: object Consul: properties: Namespace: type: string type: object ConsulConnect: properties: Gateway: $ref: '#/components/schemas/ConsulGateway' Native: type: boolean SidecarService: $ref: '#/components/schemas/ConsulSidecarService' SidecarTask: $ref: '#/components/schemas/SidecarTask' type: object ConsulExposeConfig: properties: Path: items: $ref: '#/components/schemas/ConsulExposePath' type: array type: object ConsulExposePath: properties: ListenerPort: type: string LocalPathPort: type: integer Path: type: string Protocol: type: string type: object ConsulGateway: properties: Ingress: $ref: '#/components/schemas/ConsulIngressConfigEntry' Mesh: {} Proxy: $ref: '#/components/schemas/ConsulGatewayProxy' Terminating: $ref: '#/components/schemas/ConsulTerminatingConfigEntry' type: object ConsulGatewayBindAddress: properties: Address: type: string Name: type: string Port: type: integer type: object ConsulGatewayProxy: properties: Config: additionalProperties: {} type: object ConnectTimeout: format: int64 type: integer EnvoyDNSDiscoveryType: type: string EnvoyGatewayBindAddresses: additionalProperties: $ref: '#/components/schemas/ConsulGatewayBindAddress' type: object EnvoyGatewayBindTaggedAddresses: type: boolean EnvoyGatewayNoDefaultBind: type: boolean type: object ConsulGatewayTLSConfig: properties: CipherSuites: items: type: string type: array Enabled: type: boolean TLSMaxVersion: type: string TLSMinVersion: type: string type: object ConsulIngressConfigEntry: properties: Listeners: items: $ref: '#/components/schemas/ConsulIngressListener' type: array TLS: $ref: '#/components/schemas/ConsulGatewayTLSConfig' type: object ConsulIngressListener: properties: Port: type: integer Protocol: type: string Services: items: $ref: '#/components/schemas/ConsulIngressService' type: array type: object ConsulIngressService: properties: Hosts: items: type: string type: array Name: type: string type: object ConsulLinkedService: properties: CAFile: type: string CertFile: type: string KeyFile: type: string Name: type: string SNI: type: string type: object ConsulMeshConfigEntry: {} ConsulMeshGateway: properties: Mode: type: string type: object ConsulProxy: properties: Config: additionalProperties: {} type: object ExposeConfig: $ref: '#/components/schemas/ConsulExposeConfig' LocalServiceAddress: type: string LocalServicePort: type: integer Upstreams: items: $ref: '#/components/schemas/ConsulUpstream' type: array type: object ConsulSidecarService: properties: DisableDefaultTCPCheck: type: boolean Port: type: string Proxy: $ref: '#/components/schemas/ConsulProxy' Tags: items: type: string type: array type: object ConsulTerminatingConfigEntry: properties: Services: items: $ref: '#/components/schemas/ConsulLinkedService' type: array type: object ConsulUpstream: properties: Datacenter: type: string DestinationName: type: string DestinationNamespace: type: string LocalBindAddress: type: string LocalBindPort: type: integer MeshGateway: $ref: '#/components/schemas/ConsulMeshGateway' type: object Context: type: string DNSConfig: properties: Options: items: type: string type: array Searches: items: type: string type: array Servers: items: type: string type: array type: object Deployment: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ID: type: string IsMultiregion: type: boolean JobCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobSpecModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobVersion: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string Status: type: string StatusDescription: type: string TaskGroups: additionalProperties: $ref: '#/components/schemas/DeploymentState' type: object type: object DeploymentAllocHealthRequest: properties: DeploymentID: type: string HealthyAllocationIDs: items: type: string type: array Namespace: type: string Region: type: string SecretID: type: string UnhealthyAllocationIDs: items: type: string type: array type: object DeploymentPauseRequest: properties: DeploymentID: type: string Namespace: type: string Pause: type: boolean Region: type: string SecretID: type: string type: object DeploymentPromoteRequest: properties: All: type: boolean DeploymentID: type: string Groups: items: type: string type: array Namespace: type: string Region: type: string SecretID: type: string type: object DeploymentState: properties: AutoRevert: type: boolean DesiredCanaries: type: integer DesiredTotal: type: integer HealthyAllocs: type: integer PlacedAllocs: type: integer PlacedCanaries: items: type: string type: array ProgressDeadline: format: int64 type: integer Promoted: type: boolean RequireProgressBy: format: date-time type: string UnhealthyAllocs: type: integer type: object DeploymentUnblockRequest: properties: DeploymentID: type: string Namespace: type: string Region: type: string SecretID: type: string type: object DeploymentUpdateResponse: properties: DeploymentModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalID: type: string LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer RequestTime: format: int64 type: integer RevertedJobVersion: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object DesiredTransition: properties: Migrate: type: boolean Reschedule: type: boolean type: object DesiredUpdates: properties: Canary: maximum: 1.8446744073709552e+19 minimum: 0 type: integer DestructiveUpdate: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Ignore: maximum: 1.8446744073709552e+19 minimum: 0 type: integer InPlaceUpdate: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Migrate: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Place: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Preemptions: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Stop: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object DispatchPayloadConfig: properties: File: type: string type: object DrainMetadata: properties: AccessorID: type: string Meta: additionalProperties: type: string type: object StartedAt: format: date-time type: string Status: type: string UpdatedAt: format: date-time type: string type: object DrainSpec: properties: Deadline: format: int64 type: integer IgnoreSystemJobs: type: boolean type: object DrainStatus: type: string DrainStrategy: properties: Deadline: format: int64 type: integer ForceDeadline: format: date-time type: string IgnoreSystemJobs: type: boolean StartedAt: format: date-time type: string type: object DriverInfo: properties: Attributes: additionalProperties: type: string type: object Detected: type: boolean HealthDescription: type: string Healthy: type: boolean UpdateTime: format: date-time type: string type: object Duration: format: int64 type: integer EphemeralDisk: properties: Migrate: type: boolean SizeMB: type: integer Sticky: type: boolean type: object EvalOptions: properties: ForceReschedule: type: boolean type: object Evaluation: properties: AnnotatePlan: type: boolean BlockedEval: type: string ClassEligibility: additionalProperties: type: boolean type: object CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: int64 type: integer DeploymentID: type: string EscapedComputedClass: type: boolean FailedTGAllocs: additionalProperties: $ref: '#/components/schemas/AllocationMetric' type: object ID: type: string JobID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyTime: format: int64 type: integer Namespace: type: string NextEval: type: string NodeID: type: string NodeModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer PreviousEval: type: string Priority: type: integer QueuedAllocations: additionalProperties: type: integer type: object QuotaLimitReached: type: string RelatedEvals: items: $ref: '#/components/schemas/EvaluationStub' type: array SnapshotIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Status: type: string StatusDescription: type: string TriggeredBy: type: string Type: type: string Wait: format: int64 type: integer WaitUntil: format: date-time type: string type: object EvaluationStub: properties: BlockedEval: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: int64 type: integer DeploymentID: type: string ID: type: string JobID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyTime: format: int64 type: integer Namespace: type: string NextEval: type: string NodeID: type: string PreviousEval: type: string Priority: type: integer Status: type: string StatusDescription: type: string TriggeredBy: type: string Type: type: string WaitUntil: format: date-time type: string type: object FieldDiff: properties: Annotations: items: type: string type: array Name: type: string New: type: string Old: type: string Type: type: string type: object FuzzyMatch: properties: ID: type: string Scope: items: type: string type: array type: object FuzzySearchRequest: properties: AllowStale: type: boolean AuthToken: type: string Context: type: string Filter: type: string Headers: additionalProperties: type: string type: object Namespace: type: string NextToken: type: string Params: additionalProperties: type: string type: object PerPage: format: int32 type: integer Prefix: type: string Region: type: string Reverse: type: boolean Text: type: string WaitIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer WaitTime: format: int64 type: integer type: object FuzzySearchResponse: properties: KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Matches: additionalProperties: items: $ref: '#/components/schemas/FuzzyMatch' type: array type: object NextToken: type: string RequestTime: format: int64 type: integer Truncations: additionalProperties: type: boolean type: object type: object GaugeValue: properties: Labels: additionalProperties: type: string type: object Name: type: string Value: format: float type: number type: object HostNetworkInfo: properties: CIDR: type: string Interface: type: string Name: type: string ReservedPorts: type: string type: object HostVolumeInfo: properties: Path: type: string ReadOnly: type: boolean type: object Job: properties: Affinities: items: $ref: '#/components/schemas/Affinity' type: array AllAtOnce: type: boolean Constraints: items: $ref: '#/components/schemas/Constraint' type: array ConsulNamespace: type: string ConsulToken: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Datacenters: items: type: string type: array DispatchIdempotencyToken: type: string Dispatched: type: boolean ID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Meta: additionalProperties: type: string type: object Migrate: $ref: '#/components/schemas/MigrateStrategy' ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Multiregion: $ref: '#/components/schemas/Multiregion' Name: type: string Namespace: type: string NomadTokenID: type: string ParameterizedJob: $ref: '#/components/schemas/ParameterizedJobConfig' ParentID: type: string Payload: format: byte type: string Periodic: $ref: '#/components/schemas/PeriodicConfig' Priority: type: integer Region: type: string Reschedule: $ref: '#/components/schemas/ReschedulePolicy' Spreads: items: $ref: '#/components/schemas/Spread' type: array Stable: type: boolean Status: type: string StatusDescription: type: string Stop: type: boolean SubmitTime: format: int64 type: integer TaskGroups: items: $ref: '#/components/schemas/TaskGroup' type: array Type: type: string Update: $ref: '#/components/schemas/UpdateStrategy' VaultNamespace: type: string VaultToken: type: string Version: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object JobACL: properties: Group: type: string JobID: type: string Namespace: type: string Task: type: string type: object JobChildrenSummary: properties: Dead: format: int64 type: integer Pending: format: int64 type: integer Running: format: int64 type: integer type: object JobDeregisterResponse: properties: EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextToken: type: string RequestTime: format: int64 type: integer type: object JobDiff: properties: Fields: items: $ref: '#/components/schemas/FieldDiff' type: array ID: type: string Objects: items: $ref: '#/components/schemas/ObjectDiff' type: array TaskGroups: items: $ref: '#/components/schemas/TaskGroupDiff' type: array Type: type: string type: object JobDispatchRequest: properties: JobID: type: string Meta: additionalProperties: type: string type: object Payload: format: byte type: string type: object JobDispatchResponse: properties: DispatchedJobID: type: string EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalID: type: string JobCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer RequestTime: format: int64 type: integer type: object JobEvaluateRequest: properties: EvalOptions: $ref: '#/components/schemas/EvalOptions' JobID: type: string Namespace: type: string Region: type: string SecretID: type: string type: object JobListStub: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Datacenters: items: type: string type: array ID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobSummary: $ref: '#/components/schemas/JobSummary' ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string Namespace: type: string ParameterizedJob: type: boolean ParentID: type: string Periodic: type: boolean Priority: type: integer Status: type: string StatusDescription: type: string Stop: type: boolean SubmitTime: format: int64 type: integer Type: type: string type: object JobPlanRequest: properties: Diff: type: boolean Job: $ref: '#/components/schemas/Job' Namespace: type: string PolicyOverride: type: boolean Region: type: string SecretID: type: string type: object JobPlanResponse: properties: Annotations: $ref: '#/components/schemas/PlanAnnotations' CreatedEvals: items: $ref: '#/components/schemas/Evaluation' type: array Diff: $ref: '#/components/schemas/JobDiff' FailedTGAllocs: additionalProperties: $ref: '#/components/schemas/AllocationMetric' type: object JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextPeriodicLaunch: format: date-time type: string Warnings: type: string type: object JobRegisterRequest: properties: EnforceIndex: type: boolean EvalPriority: type: integer Job: $ref: '#/components/schemas/Job' JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string PolicyOverride: type: boolean PreserveCounts: type: boolean Region: type: string SecretID: type: string type: object JobRegisterResponse: properties: EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextToken: type: string RequestTime: format: int64 type: integer Warnings: type: string type: object JobRevertRequest: properties: ConsulToken: type: string EnforcePriorVersion: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobID: type: string JobVersion: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string Region: type: string SecretID: type: string VaultToken: type: string type: object JobScaleStatusResponse: properties: JobCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobID: type: string JobModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobStopped: type: boolean Namespace: type: string TaskGroups: additionalProperties: $ref: '#/components/schemas/TaskGroupScaleStatus' type: object type: object JobStabilityRequest: properties: JobID: type: string JobVersion: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string Region: type: string SecretID: type: string Stable: type: boolean type: object JobStabilityResponse: properties: Index: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object JobSummary: properties: Children: $ref: '#/components/schemas/JobChildrenSummary' CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer JobID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string Summary: additionalProperties: $ref: '#/components/schemas/TaskGroupSummary' type: object type: object JobValidateRequest: properties: Job: $ref: '#/components/schemas/Job' Namespace: type: string Region: type: string SecretID: type: string type: object JobValidateResponse: properties: DriverConfigValidated: type: boolean Error: type: string ValidationErrors: items: type: string type: array Warnings: type: string type: object JobVersionsResponse: properties: Diffs: items: $ref: '#/components/schemas/JobDiff' type: array KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextToken: type: string RequestTime: format: int64 type: integer Versions: items: $ref: '#/components/schemas/Job' type: array type: object JobsParseRequest: properties: Canonicalize: type: boolean JobHCL: type: string hclv1: type: boolean type: object LogConfig: properties: MaxFileSizeMB: type: integer MaxFiles: type: integer type: object MetricsSummary: properties: Counters: items: $ref: '#/components/schemas/SampledValue' type: array Gauges: items: $ref: '#/components/schemas/GaugeValue' type: array Points: items: $ref: '#/components/schemas/PointValue' type: array Samples: items: $ref: '#/components/schemas/SampledValue' type: array Timestamp: type: string type: object MigrateStrategy: properties: HealthCheck: type: string HealthyDeadline: format: int64 type: integer MaxParallel: type: integer MinHealthyTime: format: int64 type: integer type: object Multiregion: properties: Regions: items: $ref: '#/components/schemas/MultiregionRegion' type: array Strategy: $ref: '#/components/schemas/MultiregionStrategy' type: object MultiregionRegion: properties: Count: type: integer Datacenters: items: type: string type: array Meta: additionalProperties: type: string type: object Name: type: string type: object MultiregionStrategy: properties: MaxParallel: type: integer OnFailure: type: string type: object Namespace: properties: Capabilities: $ref: '#/components/schemas/NamespaceCapabilities' CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Description: type: string Meta: additionalProperties: type: string type: object ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string Quota: type: string type: object NamespaceCapabilities: properties: DisabledTaskDrivers: items: type: string type: array EnabledTaskDrivers: items: type: string type: array type: object NetworkResource: properties: CIDR: type: string DNS: $ref: '#/components/schemas/DNSConfig' Device: type: string DynamicPorts: items: $ref: '#/components/schemas/Port' type: array Hostname: type: string IP: type: string MBits: type: integer Mode: type: string ReservedPorts: items: $ref: '#/components/schemas/Port' type: array type: object Node: properties: Attributes: additionalProperties: type: string type: object CSIControllerPlugins: additionalProperties: $ref: '#/components/schemas/CSIInfo' type: object CSINodePlugins: additionalProperties: $ref: '#/components/schemas/CSIInfo' type: object CgroupParent: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Datacenter: type: string Drain: type: boolean DrainStrategy: $ref: '#/components/schemas/DrainStrategy' Drivers: additionalProperties: $ref: '#/components/schemas/DriverInfo' type: object Events: items: $ref: '#/components/schemas/NodeEvent' type: array HTTPAddr: type: string HostNetworks: additionalProperties: $ref: '#/components/schemas/HostNetworkInfo' type: object HostVolumes: additionalProperties: $ref: '#/components/schemas/HostVolumeInfo' type: object ID: type: string LastDrain: $ref: '#/components/schemas/DrainMetadata' Links: additionalProperties: type: string type: object Meta: additionalProperties: type: string type: object ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string NodeClass: type: string NodeResources: $ref: '#/components/schemas/NodeResources' Reserved: $ref: '#/components/schemas/Resources' ReservedResources: $ref: '#/components/schemas/NodeReservedResources' Resources: $ref: '#/components/schemas/Resources' SchedulingEligibility: type: string Status: type: string StatusDescription: type: string StatusUpdatedAt: format: int64 type: integer TLSEnabled: type: boolean type: object NodeCpuResources: properties: CpuShares: format: int64 type: integer ReservableCpuCores: items: maximum: 65535 minimum: 0 type: integer type: array TotalCpuCores: maximum: 65535 minimum: 0 type: integer type: object NodeDevice: properties: HealthDescription: type: string Healthy: type: boolean ID: type: string Locality: $ref: '#/components/schemas/NodeDeviceLocality' type: object NodeDeviceLocality: properties: PciBusID: type: string type: object NodeDeviceResource: properties: Attributes: additionalProperties: $ref: '#/components/schemas/Attribute' type: object Instances: items: $ref: '#/components/schemas/NodeDevice' type: array Name: type: string Type: type: string Vendor: type: string type: object NodeDiskResources: properties: DiskMB: format: int64 type: integer type: object NodeDrainUpdateResponse: properties: EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalIDs: items: type: string type: array LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NodeModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer RequestTime: format: int64 type: integer type: object NodeEligibilityUpdateResponse: properties: EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalIDs: items: type: string type: array LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NodeModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer RequestTime: format: int64 type: integer type: object NodeEvent: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Details: additionalProperties: type: string type: object Message: type: string Subsystem: type: string Timestamp: format: date-time type: string type: object NodeListStub: properties: Address: type: string Attributes: additionalProperties: type: string type: object CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Datacenter: type: string Drain: type: boolean Drivers: additionalProperties: $ref: '#/components/schemas/DriverInfo' type: object ID: type: string LastDrain: $ref: '#/components/schemas/DrainMetadata' ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string NodeClass: type: string NodeResources: $ref: '#/components/schemas/NodeResources' ReservedResources: $ref: '#/components/schemas/NodeReservedResources' SchedulingEligibility: type: string Status: type: string StatusDescription: type: string Version: type: string type: object NodeMemoryResources: properties: MemoryMB: format: int64 type: integer type: object NodePurgeResponse: properties: EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalIDs: items: type: string type: array NodeModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object NodeReservedCpuResources: properties: CpuShares: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object NodeReservedDiskResources: properties: DiskMB: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object NodeReservedMemoryResources: properties: MemoryMB: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object NodeReservedNetworkResources: properties: ReservedHostPorts: type: string type: object NodeReservedResources: properties: Cpu: $ref: '#/components/schemas/NodeReservedCpuResources' Disk: $ref: '#/components/schemas/NodeReservedDiskResources' Memory: $ref: '#/components/schemas/NodeReservedMemoryResources' Networks: $ref: '#/components/schemas/NodeReservedNetworkResources' type: object NodeResources: properties: Cpu: $ref: '#/components/schemas/NodeCpuResources' Devices: items: $ref: '#/components/schemas/NodeDeviceResource' type: array Disk: $ref: '#/components/schemas/NodeDiskResources' MaxDynamicPort: type: integer Memory: $ref: '#/components/schemas/NodeMemoryResources' MinDynamicPort: type: integer Networks: items: $ref: '#/components/schemas/NetworkResource' type: array type: object NodeScoreMeta: properties: NodeID: type: string NormScore: format: double type: number Scores: additionalProperties: format: double type: number type: object type: object NodeUpdateDrainRequest: properties: DrainSpec: $ref: '#/components/schemas/DrainSpec' MarkEligible: type: boolean Meta: additionalProperties: type: string type: object NodeID: type: string type: object NodeUpdateEligibilityRequest: properties: Eligibility: type: string NodeID: type: string type: object ObjectDiff: properties: Fields: items: $ref: '#/components/schemas/FieldDiff' type: array Name: type: string Objects: items: $ref: '#/components/schemas/ObjectDiff' type: array Type: type: string type: object OneTimeToken: properties: AccessorID: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ExpiresAt: format: date-time type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer OneTimeSecretID: type: string type: object OneTimeTokenExchangeRequest: properties: OneTimeSecretID: type: string type: object OperatorHealthReply: properties: FailureTolerance: type: integer Healthy: type: boolean Servers: items: $ref: '#/components/schemas/ServerHealth' type: array type: object ParameterizedJobConfig: properties: MetaOptional: items: type: string type: array MetaRequired: items: type: string type: array Payload: type: string type: object PeriodicConfig: properties: Enabled: type: boolean ProhibitOverlap: type: boolean Spec: type: string SpecType: type: string TimeZone: type: string type: object PeriodicForceResponse: properties: EvalCreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer EvalID: type: string Index: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object PlanAnnotations: properties: DesiredTGUpdates: additionalProperties: $ref: '#/components/schemas/DesiredUpdates' type: object PreemptedAllocs: items: $ref: '#/components/schemas/AllocationListStub' type: array type: object PointValue: properties: Name: type: string Points: items: format: float type: number type: array type: object Port: properties: HostNetwork: type: string Label: type: string To: type: integer Value: type: integer type: object PortMapping: properties: HostIP: type: string Label: type: string To: type: integer Value: type: integer type: object PreemptionConfig: properties: BatchSchedulerEnabled: type: boolean ServiceSchedulerEnabled: type: boolean SysBatchSchedulerEnabled: type: boolean SystemSchedulerEnabled: type: boolean type: object QuotaLimit: properties: Hash: format: byte type: string Region: type: string RegionLimit: $ref: '#/components/schemas/Resources' VariablesLimit: type: integer type: object QuotaSpec: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Description: type: string Limits: items: $ref: '#/components/schemas/QuotaLimit' type: array ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string type: object Quotas: {} RaftConfiguration: properties: Index: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Servers: items: $ref: '#/components/schemas/RaftServer' type: array type: object RaftServer: properties: Address: type: string ID: type: string Leader: type: boolean Node: type: string RaftProtocol: type: string Voter: type: boolean type: object RequestedDevice: properties: Affinities: items: $ref: '#/components/schemas/Affinity' type: array Constraints: items: $ref: '#/components/schemas/Constraint' type: array Count: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Name: type: string type: object RescheduleEvent: properties: PrevAllocID: type: string PrevNodeID: type: string RescheduleTime: format: int64 type: integer type: object ReschedulePolicy: properties: Attempts: type: integer Delay: format: int64 type: integer DelayFunction: type: string Interval: format: int64 type: integer MaxDelay: format: int64 type: integer Unlimited: type: boolean type: object RescheduleTracker: properties: Events: items: $ref: '#/components/schemas/RescheduleEvent' type: array type: object Resources: properties: CPU: type: integer Cores: type: integer Devices: items: $ref: '#/components/schemas/RequestedDevice' type: array DiskMB: type: integer IOPS: type: integer MemoryMB: type: integer MemoryMaxMB: type: integer Networks: items: $ref: '#/components/schemas/NetworkResource' type: array type: object RestartPolicy: properties: Attempts: type: integer Delay: format: int64 type: integer Interval: format: int64 type: integer Mode: type: string type: object SampledValue: properties: Count: type: integer Labels: additionalProperties: type: string type: object Max: format: double type: number Mean: format: double type: number Min: format: double type: number Name: type: string Rate: format: double type: number Stddev: format: double type: number Sum: format: double type: number type: object ScalingEvent: properties: Count: format: int64 type: integer CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Error: type: boolean EvalID: type: string Message: type: string Meta: additionalProperties: {} type: object PreviousCount: format: int64 type: integer Time: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object ScalingPolicy: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Enabled: type: boolean ID: type: string Max: format: int64 type: integer Min: format: int64 type: integer ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string Policy: additionalProperties: {} type: object Target: additionalProperties: type: string type: object Type: type: string type: object ScalingPolicyListStub: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Enabled: type: boolean ID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Target: additionalProperties: type: string type: object Type: type: string type: object ScalingRequest: properties: Count: format: int64 type: integer Error: type: boolean Message: type: string Meta: additionalProperties: {} type: object Namespace: type: string PolicyOverride: type: boolean Region: type: string SecretID: type: string Target: additionalProperties: type: string type: object type: object SchedulerAlgorithm: type: string SchedulerConfiguration: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer MemoryOversubscriptionEnabled: type: boolean ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer PauseEvalBroker: type: boolean PreemptionConfig: $ref: '#/components/schemas/PreemptionConfig' RejectJobRegistration: type: boolean SchedulerAlgorithm: type: string type: object SchedulerConfigurationResponse: properties: KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer NextToken: type: string RequestTime: format: int64 type: integer SchedulerConfig: $ref: '#/components/schemas/SchedulerConfiguration' type: object SchedulerSetConfigurationResponse: properties: LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer RequestTime: format: int64 type: integer Updated: type: boolean type: object SearchRequest: properties: AllowStale: type: boolean AuthToken: type: string Context: type: string Filter: type: string Headers: additionalProperties: type: string type: object Namespace: type: string NextToken: type: string Params: additionalProperties: type: string type: object PerPage: format: int32 type: integer Prefix: type: string Region: type: string Reverse: type: boolean WaitIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer WaitTime: format: int64 type: integer type: object SearchResponse: properties: KnownLeader: type: boolean LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Matches: additionalProperties: items: type: string type: array type: object NextToken: type: string RequestTime: format: int64 type: integer Truncations: additionalProperties: type: boolean type: object type: object ServerHealth: properties: Address: type: string Healthy: type: boolean ID: type: string LastContact: format: int64 type: integer LastIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer LastTerm: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Leader: type: boolean Name: type: string SerfStatus: type: string StableSince: format: date-time type: string Version: type: string Voter: type: boolean type: object Service: properties: Address: type: string AddressMode: type: string CanaryMeta: additionalProperties: type: string type: object CanaryTags: items: type: string type: array CheckRestart: $ref: '#/components/schemas/CheckRestart' Checks: items: $ref: '#/components/schemas/ServiceCheck' type: array Connect: $ref: '#/components/schemas/ConsulConnect' EnableTagOverride: type: boolean Meta: additionalProperties: type: string type: object Name: type: string OnUpdate: type: string PortLabel: type: string Provider: type: string TaggedAddresses: additionalProperties: type: string type: object Tags: items: type: string type: array TaskName: type: string type: object ServiceCheck: properties: AddressMode: type: string Advertise: type: string Args: items: type: string type: array Body: type: string CheckRestart: $ref: '#/components/schemas/CheckRestart' Command: type: string Expose: type: boolean FailuresBeforeCritical: type: integer GRPCService: type: string GRPCUseTLS: type: boolean Header: additionalProperties: items: type: string type: array type: object InitialStatus: type: string Interval: format: int64 type: integer Method: type: string Name: type: string OnUpdate: type: string Path: type: string PortLabel: type: string Protocol: type: string SuccessBeforePassing: type: integer TLSSkipVerify: type: boolean TaskName: type: string Timeout: format: int64 type: integer Type: type: string type: object ServiceRegistration: properties: Address: type: string AllocID: type: string CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Datacenter: type: string ID: type: string JobID: type: string ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer Namespace: type: string NodeID: type: string Port: type: integer ServiceName: type: string Tags: items: type: string type: array type: object SidecarTask: properties: Config: additionalProperties: {} type: object Driver: type: string Env: additionalProperties: type: string type: object KillSignal: type: string KillTimeout: format: int64 type: integer LogConfig: $ref: '#/components/schemas/LogConfig' Meta: additionalProperties: type: string type: object Name: type: string Resources: $ref: '#/components/schemas/Resources' ShutdownDelay: format: int64 type: integer User: type: string type: object Spread: properties: Attribute: type: string SpreadTarget: items: $ref: '#/components/schemas/SpreadTarget' type: array Weight: maximum: 127 minimum: -128 type: integer type: object SpreadTarget: properties: Percent: maximum: 255 minimum: 0 type: integer Value: type: string type: object Task: properties: Affinities: items: $ref: '#/components/schemas/Affinity' type: array Artifacts: items: $ref: '#/components/schemas/TaskArtifact' type: array CSIPluginConfig: $ref: '#/components/schemas/TaskCSIPluginConfig' Config: additionalProperties: {} type: object Constraints: items: $ref: '#/components/schemas/Constraint' type: array DispatchPayload: $ref: '#/components/schemas/DispatchPayloadConfig' Driver: type: string Env: additionalProperties: type: string type: object KillSignal: type: string KillTimeout: format: int64 type: integer Kind: type: string Leader: type: boolean Lifecycle: $ref: '#/components/schemas/TaskLifecycle' LogConfig: $ref: '#/components/schemas/LogConfig' Meta: additionalProperties: type: string type: object Name: type: string Resources: $ref: '#/components/schemas/Resources' RestartPolicy: $ref: '#/components/schemas/RestartPolicy' ScalingPolicies: items: $ref: '#/components/schemas/ScalingPolicy' type: array Services: items: $ref: '#/components/schemas/Service' type: array ShutdownDelay: format: int64 type: integer Templates: items: $ref: '#/components/schemas/Template' type: array User: type: string Vault: $ref: '#/components/schemas/Vault' VolumeMounts: items: $ref: '#/components/schemas/VolumeMount' type: array type: object TaskArtifact: properties: GetterHeaders: additionalProperties: type: string type: object GetterMode: type: string GetterOptions: additionalProperties: type: string type: object GetterSource: type: string RelativeDest: type: string type: object TaskCSIPluginConfig: properties: HealthTimeout: format: int64 type: integer ID: type: string MountDir: type: string StagePublishBaseDir: type: string Type: type: string type: object TaskDiff: properties: Annotations: items: type: string type: array Fields: items: $ref: '#/components/schemas/FieldDiff' type: array Name: type: string Objects: items: $ref: '#/components/schemas/ObjectDiff' type: array Type: type: string type: object TaskEvent: properties: Details: additionalProperties: type: string type: object DiskLimit: format: int64 type: integer DiskSize: format: int64 type: integer DisplayMessage: type: string DownloadError: type: string DriverError: type: string DriverMessage: type: string ExitCode: type: integer FailedSibling: type: string FailsTask: type: boolean GenericSource: type: string KillError: type: string KillReason: type: string KillTimeout: format: int64 type: integer Message: type: string RestartReason: type: string SetupError: type: string Signal: type: integer StartDelay: format: int64 type: integer TaskSignal: type: string TaskSignalReason: type: string Time: format: int64 type: integer Type: type: string ValidationError: type: string VaultError: type: string type: object TaskGroup: properties: Affinities: items: $ref: '#/components/schemas/Affinity' type: array Constraints: items: $ref: '#/components/schemas/Constraint' type: array Consul: $ref: '#/components/schemas/Consul' Count: type: integer EphemeralDisk: $ref: '#/components/schemas/EphemeralDisk' MaxClientDisconnect: format: int64 type: integer Meta: additionalProperties: type: string type: object Migrate: $ref: '#/components/schemas/MigrateStrategy' Name: type: string Networks: items: $ref: '#/components/schemas/NetworkResource' type: array ReschedulePolicy: $ref: '#/components/schemas/ReschedulePolicy' RestartPolicy: $ref: '#/components/schemas/RestartPolicy' Scaling: $ref: '#/components/schemas/ScalingPolicy' Services: items: $ref: '#/components/schemas/Service' type: array ShutdownDelay: format: int64 type: integer Spreads: items: $ref: '#/components/schemas/Spread' type: array StopAfterClientDisconnect: format: int64 type: integer Tasks: items: $ref: '#/components/schemas/Task' type: array Update: $ref: '#/components/schemas/UpdateStrategy' Volumes: additionalProperties: $ref: '#/components/schemas/VolumeRequest' type: object type: object TaskGroupDiff: properties: Fields: items: $ref: '#/components/schemas/FieldDiff' type: array Name: type: string Objects: items: $ref: '#/components/schemas/ObjectDiff' type: array Tasks: items: $ref: '#/components/schemas/TaskDiff' type: array Type: type: string Updates: additionalProperties: maximum: 1.8446744073709552e+19 minimum: 0 type: integer type: object type: object TaskGroupScaleStatus: properties: Desired: type: integer Events: items: $ref: '#/components/schemas/ScalingEvent' type: array Healthy: type: integer Placed: type: integer Running: type: integer Unhealthy: type: integer type: object TaskGroupSummary: properties: Complete: type: integer Failed: type: integer Lost: type: integer Queued: type: integer Running: type: integer Starting: type: integer Unknown: type: integer type: object TaskHandle: properties: DriverState: format: byte type: string Version: type: integer type: object TaskLifecycle: properties: Hook: type: string Sidecar: type: boolean type: object TaskState: properties: Events: items: $ref: '#/components/schemas/TaskEvent' type: array Failed: type: boolean FinishedAt: format: date-time type: string LastRestart: format: date-time type: string Restarts: maximum: 1.8446744073709552e+19 minimum: 0 type: integer StartedAt: format: date-time type: string State: type: string TaskHandle: $ref: '#/components/schemas/TaskHandle' type: object Template: properties: ChangeMode: type: string ChangeScript: $ref: '#/components/schemas/ChangeScript' ChangeSignal: type: string DestPath: type: string EmbeddedTmpl: type: string Envvars: type: boolean Gid: type: integer LeftDelim: type: string Perms: type: string RightDelim: type: string SourcePath: type: string Splay: format: int64 type: integer Uid: type: integer VaultGrace: format: int64 type: integer Wait: $ref: '#/components/schemas/WaitConfig' type: object Time: format: date-time type: string UpdateStrategy: properties: AutoPromote: type: boolean AutoRevert: type: boolean Canary: type: integer HealthCheck: type: string HealthyDeadline: format: int64 type: integer MaxParallel: type: integer MinHealthyTime: format: int64 type: integer ProgressDeadline: format: int64 type: integer Stagger: format: int64 type: integer type: object Variable: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: int64 type: integer Items: $ref: '#/components/schemas/VariableItems' ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyTime: format: int64 type: integer Namespace: type: string Path: type: string type: object VariableItems: additionalProperties: type: string type: object VariableMetadata: properties: CreateIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer CreateTime: format: int64 type: integer ModifyIndex: maximum: 1.8446744073709552e+19 minimum: 0 type: integer ModifyTime: format: int64 type: integer Namespace: type: string Path: type: string type: object Vault: properties: ChangeMode: type: string ChangeSignal: type: string Env: type: boolean Namespace: type: string Policies: items: type: string type: array type: object VolumeMount: properties: Destination: type: string PropagationMode: type: string ReadOnly: type: boolean Volume: type: string type: object VolumeRequest: properties: AccessMode: type: string AttachmentMode: type: string MountOptions: $ref: '#/components/schemas/CSIMountOptions' Name: type: string PerAlloc: type: boolean ReadOnly: type: boolean Source: type: string Type: type: string type: object WaitConfig: properties: Max: format: int64 type: integer Min: format: int64 type: integer type: object float32: format: float type: number float64: format: double type: number int: type: integer int8: maximum: 127 minimum: -128 type: integer int32: format: int32 type: integer int64: format: int64 type: integer uint: minimum: 0 type: integer uint8: maximum: 255 minimum: 0 type: integer uint16: maximum: 65535 minimum: 0 type: integer uint64: maximum: 1.8446744073709552e+19 minimum: 0 type: integer securitySchemes: X-Nomad-Token: in: header name: X-Nomad-Token type: apiKey info: contact: email: support@hashicorp.com license: name: MPL 2 url: https://github.com/hashicorp/nomad/blob/main/LICENSE title: Nomad version: 1.1.4 openapi: 3.0.3 paths: /acl/bootstrap: post: operationId: PostACLBootstrap parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' responses: "200": $ref: '#/components/responses/PostACLBootstrapResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/policies: get: operationId: GetACLPolicies parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetACLPoliciesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/policy/{policyName}: delete: operationId: DeleteACLPolicy parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/ACLPolicyNameParam' responses: "200": $ref: '#/components/responses/DeleteACLPolicyResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL get: operationId: GetACLPolicy parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/ACLPolicyNameParam' responses: "200": $ref: '#/components/responses/GetACLPolicyResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL post: operationId: PostACLPolicy parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/ACLPolicyNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/ACLPolicy' required: true responses: "200": $ref: '#/components/responses/PostACLPolicyResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/token: get: operationId: GetACLTokenSelf parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetACLTokenSelfResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/token/{tokenAccessor}: delete: operationId: DeleteACLToken parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/ACLTokenAccessorParam' responses: "200": $ref: '#/components/responses/DeleteACLTokenResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL get: operationId: GetACLToken parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/ACLTokenAccessorParam' responses: "200": $ref: '#/components/responses/GetACLTokenResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL post: operationId: PostACLToken parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/ACLTokenAccessorParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/ACLToken' required: true responses: "200": $ref: '#/components/responses/PostACLTokenResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/token/onetime: post: operationId: PostACLTokenOnetime parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' responses: "200": $ref: '#/components/responses/PostACLTokenOnetimeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/token/onetime/exchange: post: operationId: PostACLTokenOnetimeExchange parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/OneTimeTokenExchangeRequest' required: true responses: "200": $ref: '#/components/responses/PostACLTokenOnetimeExchangeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /acl/tokens: get: operationId: GetACLTokens parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetACLTokensResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - ACL /allocation/{allocID}: get: operationId: GetAllocation parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/AllocIDParam' responses: "200": $ref: '#/components/responses/GetAllocationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Allocations /allocation/{allocID}/services: get: operationId: GetAllocationServices parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/AllocIDParam' responses: "200": $ref: '#/components/responses/GetAllocationServicesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Allocations /allocation/{allocID}/stop: post: operationId: PostAllocationStop parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/AllocIDParam' - $ref: '#/components/parameters/AllocNoShutdownDelayParam' responses: "200": $ref: '#/components/responses/PostAllocationStopResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Allocations /allocations: get: operationId: GetAllocations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/AllocationResourcesParam' - $ref: '#/components/parameters/AllocationsTasksStatesParam' responses: "200": $ref: '#/components/responses/GetAllocationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Allocations /deployment/{deploymentID}: get: operationId: GetDeployment parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' responses: "200": $ref: '#/components/responses/GetDeploymentResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployment/allocation-health/{deploymentID}: post: operationId: PostDeploymentAllocationHealth parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentAllocHealthRequest' required: true responses: "200": $ref: '#/components/responses/PostDeploymentAllocationHealthResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployment/allocations/{deploymentID}: get: operationId: GetDeploymentAllocations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' responses: "200": $ref: '#/components/responses/GetDeploymentAllocationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployment/fail/{deploymentID}: post: operationId: PostDeploymentFail parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' responses: "200": $ref: '#/components/responses/PostDeploymentFailResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployment/pause/{deploymentID}: post: operationId: PostDeploymentPause parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentPauseRequest' required: true responses: "200": $ref: '#/components/responses/PostDeploymentPauseResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployment/promote/{deploymentID}: post: operationId: PostDeploymentPromote parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentPromoteRequest' required: true responses: "200": $ref: '#/components/responses/PostDeploymentPromoteResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployment/unblock/{deploymentID}: post: operationId: PostDeploymentUnblock parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/DeploymentIDParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/DeploymentUnblockRequest' required: true responses: "200": $ref: '#/components/responses/PostDeploymentUnblockResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /deployments: get: operationId: GetDeployments parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetDeploymentsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Deployments /evaluation/{evalID}: get: operationId: GetEvaluation parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/EvalIDParam' responses: "200": $ref: '#/components/responses/GetEvaluationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Evaluations /evaluation/{evalID}/allocations: get: operationId: GetEvaluationAllocations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/EvalIDParam' responses: "200": $ref: '#/components/responses/GetEvaluationAllocationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Evaluations /evaluations: get: operationId: GetEvaluations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetEvaluationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Evaluations /job/{jobName}: delete: operationId: DeleteJob parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' - $ref: '#/components/parameters/JobPurgeParam' - $ref: '#/components/parameters/JobGlobalParam' responses: "200": $ref: '#/components/responses/DeleteJobResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs get: operationId: GetJob parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' responses: "200": $ref: '#/components/responses/GetJobResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs post: operationId: PostJob parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobRegisterRequest' required: true responses: "200": $ref: '#/components/responses/PostJobResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/allocations: get: operationId: GetJobAllocations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' - $ref: '#/components/parameters/JobAllocationsParam' responses: "200": $ref: '#/components/responses/GetJobAllocationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/deployment: get: operationId: GetJobDeployment parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' responses: "200": $ref: '#/components/responses/GetJobDeploymentResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/deployments: get: operationId: GetJobDeployments parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' - $ref: '#/components/parameters/AllParam' responses: "200": $ref: '#/components/responses/GetJobDeploymentsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/dispatch: post: operationId: PostJobDispatch parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobDispatchRequest' required: true responses: "200": $ref: '#/components/responses/PostJobDispatchResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/evaluate: post: operationId: PostJobEvaluate parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobEvaluateRequest' required: true responses: "200": $ref: '#/components/responses/PostJobEvaluateResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/evaluations: get: operationId: GetJobEvaluations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' responses: "200": $ref: '#/components/responses/GetJobEvaluationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/periodic/force: post: operationId: PostJobPeriodicForce parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' responses: "200": $ref: '#/components/responses/PostJobPeriodicForceResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/plan: post: operationId: PostJobPlan parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobPlanRequest' required: true responses: "200": $ref: '#/components/responses/PostJobPlanResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/revert: post: operationId: PostJobRevert parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobRevertRequest' required: true responses: "200": $ref: '#/components/responses/PostJobRevertResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/scale: get: operationId: GetJobScaleStatus parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' responses: "200": $ref: '#/components/responses/GetJobScaleStatusResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs post: operationId: PostJobScalingRequest parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/ScalingRequest' required: true responses: "200": $ref: '#/components/responses/PostJobScalingResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/stable: post: operationId: PostJobStability parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/JobNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobStabilityRequest' required: true responses: "200": $ref: '#/components/responses/PostJobStabilityResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/summary: get: operationId: GetJobSummary parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' responses: "200": $ref: '#/components/responses/GetJobSummaryResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /job/{jobName}/versions: get: operationId: GetJobVersions parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/JobNameParam' - $ref: '#/components/parameters/JobDiffsParam' responses: "200": $ref: '#/components/responses/GetJobVersionsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /jobs: get: operationId: GetJobs parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetJobsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs post: operationId: RegisterJob parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobRegisterRequest' required: true responses: "200": $ref: '#/components/responses/RegisterJobResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /jobs/parse: post: operationId: PostJobParse requestBody: content: application/json: schema: $ref: '#/components/schemas/JobsParseRequest' required: true responses: "200": $ref: '#/components/responses/PostJobParseResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' tags: - Jobs /metrics: get: operationId: GetMetricsSummary parameters: - $ref: '#/components/parameters/MetricsFormatParam' responses: "200": $ref: '#/components/responses/GetMetricsSummaryResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' tags: - Metrics /namespace: post: operationId: CreateNamespace parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' responses: "200": $ref: '#/components/responses/CreateNamespaceResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Namespaces /namespace/{namespaceName}: delete: operationId: DeleteNamespace parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/NamespaceNameParam' responses: "200": $ref: '#/components/responses/DeleteNamespaceResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Namespaces get: operationId: GetNamespace parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NamespaceNameParam' responses: "200": $ref: '#/components/responses/GetNamespaceResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Namespaces post: operationId: PostNamespace parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/NamespaceNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/Namespace' required: true responses: "200": $ref: '#/components/responses/PostNamespaceResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Namespaces /namespaces: get: operationId: GetNamespaces parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetNamespacesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Namespaces /node/{nodeId}: get: operationId: GetNode parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NodeIdParam' responses: "200": $ref: '#/components/responses/GetNodeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Nodes /node/{nodeId}/allocations: get: operationId: GetNodeAllocations parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NodeIdParam' responses: "200": $ref: '#/components/responses/GetNodeAllocationsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Nodes /node/{nodeId}/drain: post: operationId: UpdateNodeDrain parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NodeIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/NodeUpdateDrainRequest' required: true responses: "200": $ref: '#/components/responses/NodeDrainUpdateResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Nodes /node/{nodeId}/eligibility: post: operationId: UpdateNodeEligibility parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NodeIdParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/NodeUpdateEligibilityRequest' required: true responses: "200": $ref: '#/components/responses/NodeEligibilityUpdateResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Nodes /node/{nodeId}/purge: post: operationId: UpdateNodePurge parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NodeIdParam' responses: "200": $ref: '#/components/responses/NodePurgeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Nodes /nodes: get: operationId: GetNodes parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/NodeResourcesParam' responses: "200": $ref: '#/components/responses/GetNodesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Nodes /operator/autopilot/configuration: get: operationId: GetOperatorAutopilotConfiguration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetOperatorAutopilotConfigurationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator put: operationId: PutOperatorAutopilotConfiguration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/AutopilotConfiguration' required: true responses: "200": $ref: '#/components/responses/PutOperatorAutopilotConfigurationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator /operator/autopilot/health: get: operationId: GetOperatorAutopilotHealth parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetOperatorAutopilotHealthResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator /operator/raft/configuration: get: operationId: GetOperatorRaftConfiguration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetOperatorRaftConfigurationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator /operator/raft/peer: delete: operationId: DeleteOperatorRaftPeer parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' responses: "200": $ref: '#/components/responses/DeleteOperatorRaftPeerResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator /operator/scheduler/configuration: get: operationId: GetOperatorSchedulerConfiguration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetOperatorSchedulerConfigurationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator post: operationId: PostOperatorSchedulerConfiguration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/SchedulerConfiguration' required: true responses: "200": $ref: '#/components/responses/PostOperatorSchedulerConfigurationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Operator /plugin/csi/{pluginID}: get: operationId: GetPluginCSI parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/PluginIDParam' responses: "200": $ref: '#/components/responses/GetPluginCSIResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Plugins /plugins: get: operationId: GetPlugins parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetPluginsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Plugins /quota: post: operationId: CreateQuotaSpec parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/QuotaSpec' required: true responses: "200": $ref: '#/components/responses/CreateQuotaSpecResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Enterprise /quota/{specName}: delete: operationId: DeleteQuotaSpec parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/QuotaSpecNameParam' responses: "200": $ref: '#/components/responses/DeleteNamespaceResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Enterprise get: operationId: GetQuotaSpec parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/QuotaSpecNameParam' responses: "200": $ref: '#/components/responses/GetQuotaSpecResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Enterprise post: operationId: PostQuotaSpec parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/QuotaSpecNameParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/QuotaSpec' required: true responses: "200": $ref: '#/components/responses/PostQuotaSpecResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Enterprise /quotas: get: operationId: GetQuotas parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetQuotasResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Enterprise /regions: get: operationId: GetRegions responses: "200": $ref: '#/components/responses/GetRegionsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' tags: - Regions /scaling/policies: get: operationId: GetScalingPolicies parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetScalingPoliciesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Scaling /scaling/policy/{policyID}: get: operationId: GetScalingPolicy parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/ScalingPolicyIDParam' responses: "200": $ref: '#/components/responses/GetScalingPolicyResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Scaling /search: post: operationId: GetSearch parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' required: true responses: "200": $ref: '#/components/responses/GetSearchResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Search /search/fuzzy: post: operationId: GetFuzzySearch parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/FuzzySearchRequest' required: true responses: "200": $ref: '#/components/responses/GetFuzzySearchResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Search /status/leader: get: operationId: GetStatusLeader parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetStatusLeaderResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Status /status/peers: get: operationId: GetStatusPeers parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetStatusPeersResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Status /system/gc: put: operationId: PutSystemGC parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' responses: "200": $ref: '#/components/responses/PutSystemGCResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - System /system/reconcile/summaries: put: operationId: PutSystemReconcileSummaries parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' responses: "200": $ref: '#/components/responses/PutSystemReconcileSummariesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - System /validate/job: post: operationId: PostJobValidateRequest parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/JobValidateRequest' required: true responses: "200": $ref: '#/components/responses/PostJobValidateResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Jobs /var/{path}: delete: operationId: DeleteVariable parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VariablePath' - $ref: '#/components/parameters/VariableCAS' requestBody: content: application/json: schema: $ref: '#/components/schemas/Variable' required: true responses: "200": $ref: '#/components/responses/DeleteVariableResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Variables get: operationId: GetVariableQuery parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/VariablePath' responses: "200": $ref: '#/components/responses/GetVariableResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Variables post: operationId: PostVariable parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VariablePath' - $ref: '#/components/parameters/VariableCAS' requestBody: content: application/json: schema: $ref: '#/components/schemas/Variable' required: true responses: "200": $ref: '#/components/responses/PostVariableResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Variables put: operationId: PutVariable parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VariablePath' - $ref: '#/components/parameters/VariableCAS' requestBody: content: application/json: schema: $ref: '#/components/schemas/Variable' required: true responses: "200": $ref: '#/components/responses/PutVariableResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Variables /vars: get: operationId: GetVariablesListRequest parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' responses: "200": $ref: '#/components/responses/GetVariablesListResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Variables /volume/csi/{volumeId}: delete: operationId: DeleteVolumeRegistration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VolumeIDParam' - $ref: '#/components/parameters/VolumeForceParam' responses: "200": $ref: '#/components/responses/DeleteVolumeRegistrationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes get: operationId: GetVolume parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/VolumeIDParam' responses: "200": $ref: '#/components/responses/GetVolumeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes post: operationId: PostVolumeRegistration parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VolumeIDParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/CSIVolumeRegisterRequest' required: true responses: "200": $ref: '#/components/responses/PostVolumeRegistrationResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes /volume/csi/{volumeId}/{action}: delete: operationId: DetachOrDeleteVolume parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VolumeIDParam' - $ref: '#/components/parameters/VolumeNodeParam' - $ref: '#/components/parameters/VolumeActionParam' responses: "200": $ref: '#/components/responses/DetachOrDeleteVolumeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes post: operationId: CreateVolume parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VolumeIDParam' - $ref: '#/components/parameters/VolumeActionParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/CSIVolumeCreateRequest' required: true responses: "200": $ref: '#/components/responses/PostVolumeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes /volumes: get: operationId: GetVolumes parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/VolumeNodeIDParam' - $ref: '#/components/parameters/VolumePluginIDParam' - $ref: '#/components/parameters/VolumeTypeParam' responses: "200": $ref: '#/components/responses/GetVolumesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes post: operationId: PostVolume parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/CSIVolumeRegisterRequest' required: true responses: "200": $ref: '#/components/responses/PostVolumeResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes /volumes/external: get: operationId: GetExternalVolumes parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/VolumePluginIDParam' responses: "200": $ref: '#/components/responses/GetExternalVolumesResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes /volumes/snapshot: delete: operationId: DeleteSnapshot parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' - $ref: '#/components/parameters/VolumePluginIDParam' - $ref: '#/components/parameters/SnapshotIDParam' responses: "200": $ref: '#/components/responses/DeleteSnapshotResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes get: operationId: GetSnapshots parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/IndexHeader' - $ref: '#/components/parameters/WaitParam' - $ref: '#/components/parameters/StaleParam' - $ref: '#/components/parameters/PrefixParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/PerPageParam' - $ref: '#/components/parameters/NextTokenParam' - $ref: '#/components/parameters/VolumePluginIDParam' responses: "200": $ref: '#/components/responses/GetSnapshotsResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes post: operationId: PostSnapshot parameters: - $ref: '#/components/parameters/RegionParam' - $ref: '#/components/parameters/NamespaceParam' - $ref: '#/components/parameters/NomadTokenHeader' - $ref: '#/components/parameters/IdempotencyTokenParam' requestBody: content: application/json: schema: $ref: '#/components/schemas/CSISnapshotCreateRequest' required: true responses: "200": $ref: '#/components/responses/PostSnapshotResponse' "400": $ref: '#/components/responses/BadRequestResponse' "403": $ref: '#/components/responses/ForbiddenResponse' "405": $ref: '#/components/responses/MethodNotAllowedResponse' "500": $ref: '#/components/responses/InternalServerErrorResponse' security: - X-Nomad-Token: [] tags: - Volumes security: - X-Nomad-Token: [] servers: - description: dev-agent url: '{scheme}://{address}:{port}/v1' variables: address: default: 127.0.0.1 port: default: "4646" scheme: default: http enum: - https - http - description: agent url: '{scheme}://{address}:{port}/v1' variables: address: default: 127.0.0.1 port: default: "4646" scheme: default: https enum: - https - http