Skip to content

SystemApi.md

Latest commit

 

History

History
143 lines (96 loc) · 4.37 KB

SystemApi.md

File metadata and controls

143 lines (96 loc) · 4.37 KB

.SystemApi

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

Method HTTP request Description
putSystemGC PUT /system/gc
putSystemReconcileSummaries PUT /system/reconcile/summaries

putSystemGC

void putSystemGC()

Example

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

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

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

putSystemReconcileSummaries

void putSystemReconcileSummaries()

Example

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

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

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