.NamespacesApi

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

Method	HTTP request	Description
createNamespace	POST /namespace
deleteNamespace	DELETE /namespace/{namespaceName}
getNamespace	GET /namespace/{namespaceName}
getNamespaces	GET /namespaces
postNamespace	POST /namespace/{namespaceName}

createNamespace

void createNamespace()

Example

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

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

let body:.NamespacesApiCreateNamespaceRequest = {
  // 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",
};

apiInstance.createNamespace(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
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

Return type

void

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
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]

deleteNamespace

void deleteNamespace()

Example

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

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

let body:.NamespacesApiDeleteNamespaceRequest = {
  // string | The namespace identifier.
  namespaceName: "namespaceName_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",
};

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

Parameters

Name	Type	Description	Notes
namespaceName	[string]	The namespace identifier.	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

Return type

void

Authorization

X-Nomad-Token

HTTP request headers

Content-Type: Not defined
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]

getNamespace

Namespace getNamespace()

Example

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

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

let body:.NamespacesApiGetNamespaceRequest = {
  // string | The namespace identifier.
  namespaceName: "namespaceName_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.getNamespace(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
namespaceName	[string]	The namespace identifier.	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

Namespace

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]

getNamespaces

Array getNamespaces()

Example

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

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

let body:.NamespacesApiGetNamespacesRequest = {
  // 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.getNamespaces(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]

postNamespace

void postNamespace(namespace2)

Example

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

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

let body:.NamespacesApiPostNamespaceRequest = {
  // string | The namespace identifier.
  namespaceName: "namespaceName_example",
  // Namespace
  namespace2: {
    capabilities: {
      disabledTaskDrivers: [
        "disabledTaskDrivers_example",
      ],
      enabledTaskDrivers: [
        "enabledTaskDrivers_example",
      ],
    },
    createIndex: 0,
    description: "description_example",
    meta: {
      "key": "key_example",
    },
    modifyIndex: 0,
    name: "name_example",
    quota: "quota_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",
};

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

Parameters

Name	Type	Description	Notes
namespace2	Namespace
namespaceName	[string]	The namespace identifier.	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

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]

Files

NamespacesApi.md

Latest commit

History

NamespacesApi.md

File metadata and controls

.NamespacesApi

createNamespace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteNamespace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getNamespace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getNamespaces

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

postNamespace

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details