.VariablesApi

All URIs are relative to http://127.0.0.1:4646/v1

Method	HTTP request	Description
deleteVariable	DELETE /var/{path}
getVariableQuery	GET /var/{path}
getVariablesListRequest	GET /vars
postVariable	POST /var/{path}
putVariable	PUT /var/{path}

deleteVariable

void deleteVariable(variable)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .VariablesApi(configuration);

let body:.VariablesApiDeleteVariableRequest = {
  // string | A path to a Nomad Variable
  path: "path_example",
  // Variable
  variable: {
    createIndex: 0,
    createTime: 1,
    items: {
      "key": "key_example",
    },
    modifyIndex: 0,
    modifyTime: 1,
    namespace: "namespace_example",
    path: "path_example",
  },
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // string | Can be used to ensure operations are only run once. (optional)
  idempotencyToken: "idempotency_token_example",
  // number | A compare-and-set parameter for Nomad Variables (optional)
  cas: 1,
};

apiInstance.deleteVariable(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
variable	Variable
path	[string]	A path to a Nomad Variable	defaults to undefined
region	[string]	Filters results based on the specified region.	(optional) defaults to undefined
namespace	[string]	Filters results based on the specified namespace.	(optional) defaults to undefined
xNomadToken	[string]	A Nomad ACL token.	(optional) defaults to undefined
idempotencyToken	[string]	Can be used to ensure operations are only run once.	(optional) defaults to undefined
cas	[number]	A compare-and-set parameter for Nomad Variables	(optional) defaults to undefined

Return type

void

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: application/json
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVariableQuery

Variable getVariableQuery()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .VariablesApi(configuration);

let body:.VariablesApiGetVariableQueryRequest = {
  // string | A path to a Nomad Variable
  path: "path_example",
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // number | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional)
  index: 1,
  // string | Provided with IndexParam to wait for change. (optional)
  wait: "wait_example",
  // string | If present, results will include stale reads. (optional)
  stale: "stale_example",
  // string | Constrains results to jobs that start with the defined prefix (optional)
  prefix: "prefix_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // number | Maximum number of results to return. (optional)
  perPage: 1,
  // string | Indicates where to start paging for queries that support pagination. (optional)
  nextToken: "next_token_example",
};

apiInstance.getVariableQuery(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
path	[string]	A path to a Nomad Variable	defaults to undefined
region	[string]	Filters results based on the specified region.	(optional) defaults to undefined
namespace	[string]	Filters results based on the specified namespace.	(optional) defaults to undefined
index	[number]	If set, wait until query exceeds given index. Must be provided with WaitParam.	(optional) defaults to undefined
wait	[string]	Provided with IndexParam to wait for change.	(optional) defaults to undefined
stale	[string]	If present, results will include stale reads.	(optional) defaults to undefined
prefix	[string]	Constrains results to jobs that start with the defined prefix	(optional) defaults to undefined
xNomadToken	[string]	A Nomad ACL token.	(optional) defaults to undefined
perPage	[number]	Maximum number of results to return.	(optional) defaults to undefined
nextToken	[string]	Indicates where to start paging for queries that support pagination.	(optional) defaults to undefined

Return type

Variable

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. * X-Nomad-KnownLeader - Boolean indicating if there is a known cluster leader. * X-Nomad-LastContact - The time in milliseconds that a server was last contacted by the leader node.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVariablesListRequest

Array getVariablesListRequest()

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .VariablesApi(configuration);

let body:.VariablesApiGetVariablesListRequestRequest = {
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // number | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional)
  index: 1,
  // string | Provided with IndexParam to wait for change. (optional)
  wait: "wait_example",
  // string | If present, results will include stale reads. (optional)
  stale: "stale_example",
  // string | Constrains results to jobs that start with the defined prefix (optional)
  prefix: "prefix_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // number | Maximum number of results to return. (optional)
  perPage: 1,
  // string | Indicates where to start paging for queries that support pagination. (optional)
  nextToken: "next_token_example",
};

apiInstance.getVariablesListRequest(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
region	[string]	Filters results based on the specified region.	(optional) defaults to undefined
namespace	[string]	Filters results based on the specified namespace.	(optional) defaults to undefined
index	[number]	If set, wait until query exceeds given index. Must be provided with WaitParam.	(optional) defaults to undefined
wait	[string]	Provided with IndexParam to wait for change.	(optional) defaults to undefined
stale	[string]	If present, results will include stale reads.	(optional) defaults to undefined
prefix	[string]	Constrains results to jobs that start with the defined prefix	(optional) defaults to undefined
xNomadToken	[string]	A Nomad ACL token.	(optional) defaults to undefined
perPage	[number]	Maximum number of results to return.	(optional) defaults to undefined
nextToken	[string]	Indicates where to start paging for queries that support pagination.	(optional) defaults to undefined

Return type

Array

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1. * X-Nomad-KnownLeader - Boolean indicating if there is a known cluster leader. * X-Nomad-LastContact - The time in milliseconds that a server was last contacted by the leader node.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

postVariable

Variable postVariable(variable)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .VariablesApi(configuration);

let body:.VariablesApiPostVariableRequest = {
  // string | A path to a Nomad Variable
  path: "path_example",
  // Variable
  variable: {
    createIndex: 0,
    createTime: 1,
    items: {
      "key": "key_example",
    },
    modifyIndex: 0,
    modifyTime: 1,
    namespace: "namespace_example",
    path: "path_example",
  },
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // string | Can be used to ensure operations are only run once. (optional)
  idempotencyToken: "idempotency_token_example",
  // number | A compare-and-set parameter for Nomad Variables (optional)
  cas: 1,
};

apiInstance.postVariable(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
variable	Variable
path	[string]	A path to a Nomad Variable	defaults to undefined
region	[string]	Filters results based on the specified region.	(optional) defaults to undefined
namespace	[string]	Filters results based on the specified namespace.	(optional) defaults to undefined
xNomadToken	[string]	A Nomad ACL token.	(optional) defaults to undefined
idempotencyToken	[string]	Can be used to ensure operations are only run once.	(optional) defaults to undefined
cas	[number]	A compare-and-set parameter for Nomad Variables	(optional) defaults to undefined

Return type

Variable

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putVariable

Variable putVariable(variable)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .VariablesApi(configuration);

let body:.VariablesApiPutVariableRequest = {
  // string | A path to a Nomad Variable
  path: "path_example",
  // Variable
  variable: {
    createIndex: 0,
    createTime: 1,
    items: {
      "key": "key_example",
    },
    modifyIndex: 0,
    modifyTime: 1,
    namespace: "namespace_example",
    path: "path_example",
  },
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // string | Can be used to ensure operations are only run once. (optional)
  idempotencyToken: "idempotency_token_example",
  // number | A compare-and-set parameter for Nomad Variables (optional)
  cas: 1,
};

apiInstance.putVariable(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
variable	Variable
path	[string]	A path to a Nomad Variable	defaults to undefined
region	[string]	Filters results based on the specified region.	(optional) defaults to undefined
namespace	[string]	Filters results based on the specified namespace.	(optional) defaults to undefined
xNomadToken	[string]	A Nomad ACL token.	(optional) defaults to undefined
idempotencyToken	[string]	Can be used to ensure operations are only run once.	(optional) defaults to undefined
cas	[number]	A compare-and-set parameter for Nomad Variables	(optional) defaults to undefined

Return type

Variable

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200		* X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1.
400	Bad request	-
403	Forbidden	-
405	Method not allowed	-
500	Internal server error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

VariablesApi.md

Latest commit

History

VariablesApi.md

File metadata and controls

.VariablesApi

deleteVariable

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVariableQuery

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getVariablesListRequest

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postVariable

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

putVariable

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details