Skip to content

Latest commit

 

History

History
271 lines (179 loc) · 8.1 KB

TokensApiControllerApi.md

File metadata and controls

271 lines (179 loc) · 8.1 KB
Raw

SematextApiClientJavascript.TokensApiControllerApi

All URIs are relative to /

Method HTTP request Description
createAppToken POST /users-web/api/v3/apps/{appId}/tokens Create new app token
deleteAppToken1 DELETE /users-web/api/v3/apps/{appId}/tokens/{tokenId} Delete app token
getAppTokens1 GET /users-web/api/v3/apps/{appId}/tokens Get app available tokens
regenerateAppToken1 POST /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate Regenerate app token)
updateAppToken PUT /users-web/api/v3/apps/{appId}/tokens/{tokenId} Update app token (enable/disable or name)

createAppToken

TokenResponse createAppToken(body, appId)

Create new app token

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TokensApiControllerApi();
let body = new SematextApiClientJavascript.CreateTokenDto(); // CreateTokenDto | dto
let appId = 789; // Number | appId

apiInstance.createAppToken(body, appId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body CreateTokenDto dto
appId Number appId

Return type

TokenResponse

Authorization

api_key

HTTP request headers

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

deleteAppToken1

GenericMapBasedApiResponse deleteAppToken1(appId, tokenId)

Delete app token

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TokensApiControllerApi();
let appId = 789; // Number | appId
let tokenId = 789; // Number | tokenId

apiInstance.deleteAppToken1(appId, tokenId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appId Number appId
tokenId Number tokenId

Return type

GenericMapBasedApiResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getAppTokens1

TokensResponse getAppTokens1(appId)

Get app available tokens

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TokensApiControllerApi();
let appId = 789; // Number | appId

apiInstance.getAppTokens1(appId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appId Number appId

Return type

TokensResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

regenerateAppToken1

TokenResponse regenerateAppToken1(appId, tokenId)

Regenerate app token)

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TokensApiControllerApi();
let appId = 789; // Number | appId
let tokenId = 789; // Number | tokenId

apiInstance.regenerateAppToken1(appId, tokenId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
appId Number appId
tokenId Number tokenId

Return type

TokenResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateAppToken

TokenResponse updateAppToken(body, appId, tokenId)

Update app token (enable/disable or name)

Example

import {SematextApiClientJavascript} from 'sematext-api-client-javascript';
let defaultClient = SematextApiClientJavascript.ApiClient.instance;

// Configure API key authorization: api_key
let api_key = defaultClient.authentications['api_key'];
api_key.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix = 'Token';

let apiInstance = new SematextApiClientJavascript.TokensApiControllerApi();
let body = new SematextApiClientJavascript.UpdateTokenDto(); // UpdateTokenDto | dto
let appId = 789; // Number | appId
let tokenId = 789; // Number | tokenId

apiInstance.updateAppToken(body, appId, tokenId).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
body UpdateTokenDto dto
appId Number appId
tokenId Number tokenId

Return type

TokenResponse

Authorization

api_key

HTTP request headers

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