apps

 

Creates an app with the specified parameters.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

name
string
required

Name of the app that is to be created.

scheduler
string

Scheduler of the app that is to be created

Response

AppResponse represents an app.

Idstring

The ID of the app

Namestring

The name of the app

Schedulerstring

The scheduler associated with the app

Slugstring

A unique slug for the app

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Deletes an app by ID.

Requires secondary authentication in request params.

 
 Authentication is required for this endpoint.
deletehttps://api.replicated.com/vendor/v1/app/app_id
curl --request DELETE \
  --url https://api.replicated.com/vendor/v1/app/app_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.replicated.com/vendor/v1/app/app_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.replicated.com/vendor/v1/app/app_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Body Params

password
string
required

Password of the user

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Removes branding from an app channel.

Requires secondary authentication in request params.

 
 Authentication is required for this endpoint.
deletehttps://api.replicated.com/vendor/v1/app/app_id/branding
curl --request DELETE \
  --url 'https://api.replicated.com/vendor/v1/app/app_id/branding?channelID=channelID'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/branding',
  qs: { channelID: 'channelID' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/branding?channelID=channelID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.replicated.com/vendor/v1/app/app_id/branding?channelID=channelID");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/branding"

querystring = {"channelID":"channelID"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Query Params

channelID
string
required

ID of the channel to remove branding from.

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Lists all apps and their channels.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/apps
curl --request GET \
  --url https://api.replicated.com/vendor/v1/apps
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/apps' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/apps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/apps");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/apps"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

ListAppsResponse represents a list of apps and the corresponding channels.

Return if the caller is not authorized

Returned if the caller does not have the needed permission

app

 

Lists all apps and their channels.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/branding
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/branding
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/branding' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/branding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/branding");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/branding"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Response

ListBrandingResponse represents the return value for a list branding call.

brandingobject
channelsarray

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

/app/{app_id}/branding

Adds CSS to a specific app channel

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/branding
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/branding
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/branding' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/branding")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/branding");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/branding"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Body Params

channel_id
string
required

ChannelID to create branding for

css
string
required

CSS to apply to the channel

Response

CreateBrandingResponse represents a branding object

createdstring
cssstring
defaultboolean
updatedstring

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

List channels for an app.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/channels
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/channels
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/channels' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/channels");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/channels"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Response

ListChannelsResponse contains the JSON channels list

AppChannelsarray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

List license fields for a given appId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/licensefield
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/licensefield
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/licensefield' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/licensefield")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/licensefield");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/licensefield"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Response

ListLicenseFieldsResponse contains the list of license fields

ListAppLicenseFieldsResponsearray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Create a license field for a given app.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/licensefield
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/licensefield
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/licensefield' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/licensefield")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/licensefield");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/licensefield"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Body Params

default
string
required
hidden
boolean
required
name
string
required
required
boolean
required
title
string
required
type
string
required

Response

CreateLicenseFieldResponse contains the response of all license fields

ListAppLicenseFieldsResponsearray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update a license field for a given appId and licenseFieldName.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

license_field_name
string
required

App identifier

Body Params

default
string
required

Optional default value for this licensefield.

hidden
boolean
required

Indicates if this field will be visible from the on-premise license screen.

title
string
required

Title of custom license field to display.

Response

EditLicenseFieldResponse contains the license fields

ListAppLicenseFieldsResponsearray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Delete a field for a given app and named field.

 
 Authentication is required for this endpoint.
deletehttps://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name
curl --request DELETE \
  --url https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/licensefield/license_field_name"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

license_field_name
string
required

Field name

Response

DeleteLicenseFieldResponse contains the response from deleting a license field

ListAppLicenseFieldsResponsearray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

List all licenses for a given appId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/licenses
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/licenses
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/licenses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/licenses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/licenses");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/licenses"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Response

ListAppLicensesResponse contains the list of licenses

Licensesarray

Returned on bad input

List license billing events for a given license_id.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/license/license_id/billing-events
curl --request GET \
  --url https://api.replicated.com/vendor/v1/license/license_id/billing-events
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/billing-events' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/billing-events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/license/license_id/billing-events");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/billing-events"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

GetLicenseBillingEventsResponse contains the list of license billing events

BillingEventsarray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

channel

 

Create a channel for an app.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/channel
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/channel
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/channel' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/channel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/channel");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/channel"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Body Params

airgap_enabled
boolean
description
string
name
string
required

Response

CreateChannelResponse contains the JSON channels list

AppChannelarray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update a channel for an app.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/channel/channel_id
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

channel_id
string
required

Channel identifier

Body Params

airgap_enabled
boolean
description
string
is_default
boolean
name
string
required

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Archive a channel for an app.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/archive
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/archive
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/archive' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/archive");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/archive"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

channel_id
string
required

Channel identifier

Response

On success

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update an existing release.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/release/sequence
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/release/sequence
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/release/sequence' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/release/sequence")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/release/sequence");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/release/sequence"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

channel_id
string
required

Channel identifier

Body Params

release_notes
string
required
required
boolean
required
version
string
required

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

List the releases for an app channel.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/releases
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/releases
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/releases' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/releases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/releases");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/channel/channel_id/releases"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

channel_id
string
required

Channel identifier

Response

ListChannelReleasesResponse lists the channel releases

channelobject

An app channel belongs to an app. It contains references to the top (current)
release in the channel.

channel.Adoptionobject

ChannelAdoption represents the versions that licenses are on in the channel

channel.Adoption.current_version_count_activeobject
channel.Adoption.current_version_count_allobject
channel.Adoption.other_version_count_activeobject
channel.Adoption.other_version_count_allobject
channel.Adoption.previous_version_count_activeobject
channel.Adoption.previous_version_count_allobject
channel.AirgapEnabledboolean

AirgapEnabled indicates if airgap builds will be created automatically for this channel

channel.Descriptionstring

Description that will be shown during license installation

channel.Idstring

The ID of the channel

channel.IsDefaultboolean

IsDefault shows if channel is default or not

channel.LicenseCountsobject

LicenseCounts is a struct to hold license count information

channel.LicenseCounts.activeobject
channel.LicenseCounts.airgapobject
channel.LicenseCounts.inactiveobject
channel.LicenseCounts.totalobject
channel.Namestring

The name of channel

channel.Positioninteger

The position for which the channel occurs in a list

channel.ReleaseLabelstring

The label of the current release sequence

channel.ReleaseNotesstring

Release notes for the current release sequence

channel.ReleaseSequenceinteger

A reference to the current release sequence

releasesarray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

licenses

 

Search for a given license by appId and licenseField.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/licenses/search
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/licenses/search
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/licenses/search' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/licenses/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/licenses/search");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/licenses/search"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Body Params

fields
array of objects
required

An array of fields that have values you are trying to search for

field
value 

Response

LicensesSearchResponse contains the search response

LicenseIDsarray

List of License IDs

Returned on bad input

Lists all licenses.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/licenses
curl --request GET \
  --url https://api.replicated.com/vendor/v1/licenses
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/licenses' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/licenses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/licenses");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/licenses"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Response

ListLicensesResponse contains the parameters needed to call list licenses

Licensesarray

release

 

Create a new release.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/release
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/release
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/release' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/release")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/release");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/release"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Body Params

source
string

Currently supported values for this field are "copy" and "latest".
When set to "copy", sourcedata must be set to release number to copy YAML from.
When set to "latest", YAML will be copied from the latest app release.
When omitted, the release will be created with default placeholder YAML.

sourcedata
int64
required

If source is set to "copy", sourcedata must be the release number to copy YAML from.

Response

CreateReleaseResponse contains the new release properties

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Batch archive releases.

 
 Authentication is required for this endpoint.
deletehttps://api.replicated.com/vendor/v1/app/app_id/release
curl --request DELETE \
  --url 'https://api.replicated.com/vendor/v1/app/app_id/release?sequence=sequence'
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/release',
  qs: { sequence: 'sequence' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/release?sequence=sequence")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.replicated.com/vendor/v1/app/app_id/release?sequence=sequence");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/release"

querystring = {"sequence":"sequence"}

response = requests.request("DELETE", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Query Params

sequence
array of integers
required

Sequences of the releases to archive

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Archive a release.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/sequence/archive
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/sequence/archive
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/sequence/archive' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/sequence/archive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/sequence/archive");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/sequence/archive"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Get the release preflight checks.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/sequence/preflightchecks
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/sequence/preflightchecks
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/sequence/preflightchecks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/sequence/preflightchecks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/sequence/preflightchecks");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/sequence/preflightchecks"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

Response

ReadPreflightChecksResponse release preflight checks

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Promote a release.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/app/app_id/sequence/promote
curl --request POST \
  --url https://api.replicated.com/vendor/v1/app/app_id/sequence/promote
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/sequence/promote' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/sequence/promote")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/app/app_id/sequence/promote");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/sequence/promote"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

Body Params

channels
array of strings
required
label
string
required
release_notes
string
required
required
boolean
required

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Get the release properties.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/sequence/properties
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/sequence/properties
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/sequence/properties' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/sequence/properties")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/sequence/properties");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/sequence/properties"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

Response

ReadReleaseResponse release properties

Configstring
CreatedAtstring
Editableboolean
EditedAtstring
Sequenceinteger

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Get the release config.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/sequence/raw
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/sequence/raw
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/sequence/raw' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/sequence/raw")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/sequence/raw");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/sequence/raw"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

Response

ReadRawReleaseResponse contains the app config contents

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update the release config.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/app/app_id/sequence/raw
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/app/app_id/sequence/raw
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/sequence/raw' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/sequence/raw")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/app/app_id/sequence/raw");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/sequence/raw"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

sequence
int64
required

Release identifier

Response

UpdateRawReleaseResponse contains the app config contents

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Returned on a conflict

releases

 

Lists the releases for an app.

Deprecated - please use the list releases with paging route.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/releases
curl --request GET \
  --url https://api.replicated.com/vendor/v1/app/app_id/releases
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/releases' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/releases")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/releases");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/releases"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Response

ListAppResponse contains a JSON array of app release data

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Returns a paged set of releases for an app.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/app/app_id/releases/paged
curl --request GET \
  --url 'https://api.replicated.com/vendor/v1/app/app_id/releases/paged?start=start&count=count'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/app/app_id/releases/paged',
  qs: 
   { start: 'start',
     count: 'count' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/app/app_id/releases/paged?start=start&count=count")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/app/app_id/releases/paged?start=start&count=count");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/app/app_id/releases/paged"

querystring = {"start":"start","count":"count"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

app_id
string
required

App identifier

Query Params

start
int64
required

Start of the next page, defaults to zero

count
int64
required

Number of elements to return per page, defaults to 30

Response

AppResponse represents an app.

Idstring

The ID of the app

Namestring

The name of the app

Schedulerstring

The scheduler associated with the app

Slugstring

A unique slug for the app

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

auditlog

 

Returns a new Audit Log token scoped to the current user.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/auditlogtoken
curl --request GET \
  --url https://api.replicated.com/vendor/v1/auditlogtoken
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/auditlogtoken' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/auditlogtoken")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/auditlogtoken");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/auditlogtoken"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

target_id
string

Response

GetAuditLogTokenResponse represents a single audit log token

Return if the caller is not authorized

Returned if the caller does not have the needed permission

license

 

Create a license.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/license
curl --request POST \
  --url https://api.replicated.com/vendor/v1/license
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/license' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/license");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

activation_email
string
required

If activation is required this is the email the code will be sent to.

airgap_download_enabled
boolean
required
app_id
string
required

App Id that this license will be associated with.

assignee
string
required

License Label name, ie name of customer who is using license.

assisted_setup_enabled
boolean

deprecated

channel_id
string
required

Channel id that the license will be associated with.

expiration_date
string
required

Date that the license will expire, can be null for no expiration or formatted by year-month-day ex. 2016-02-02.

expiration_policy
string
required

Defines expiration policy for this license.

Values:
ignore: replicated will take no action on a expired license
noupdate-norestart: application updates will not be downloaded, and once the application is stopped, it will not be started again
noupdate-stop: application updates will not be downloaded and the application will be stopped

external_support_bundle
boolean

Defines whether this license should use the external support bundle generator.

field_values
array of objects
required

An array of field values for custom fields of a given app

field
title
type
value
license_type
string
required

LicenseType can be set to "dev", "trial", or "prod"

require_activation
boolean
required

If this license requires activation set to true, make sure to set activation email as well.

update_policy
string
required

If set to automatic will auto update remote license installation with every release. If set to manual will update only when on-premise admin clicks the install update button.

use_console_support_spec
boolean

Defines whether this license should use support bundle specs from console.

Response

CreateLicenseResponse contains the created license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Returned if the caller does not have the needed permission

Returned on resource not found

Get app license for a given licenseId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/license/license_id
curl --request GET \
  --url https://api.replicated.com/vendor/v1/license/license_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/license/license_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/license/license_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

GetLicenseResponse contains the returned license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update app license for a given licenseId.

Note: that all fields are required to be passed or they will be overwritten to blank or default values.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

activation_email
string
required

If activation is required this is the email the code will be sent to.

airgap_download_enabled
boolean
required
assignee
string
required

License Label name, ie name of customer who is using license.

assisted_setup_enabled
boolean
required
channel_id
string
required

Channel id that the license will be associated with.

expiration_date
string
required

Date that the license will expire, can be null for no expiration or formated by year-month-day ex. 2016-02-02.

expiration_policy
string
required

Defines expiration policy for this license.

Values:
ignore: replicated will take no action on a expired license
noupdate-norestart: application updates will not be downloaded, and once the application is stopped, it will not be started again
noupdate-stop: application updates will not be downloaded and the application will be stopped

external_support_bundle
boolean

Defines whether this license should use the external support bundle generator.

field_values
array of objects
required

An array of field values for custom fields of a given app

field
title
type
value
is_app_version_locked
boolean

A license can be optionally locked to a specific release

license_type
string
required

LicenseType can be set to "dev", "trial", or "prod"

locked_app_version
int64

If app version is locked, this is the version to lock it to (sequence)

require_activation
boolean
required

If this license requires activation set to true, make sure to set activation email as well.

update_policy
string
required

If set to automatic will auto update remote license installation with every release. If set to manual will update only when on-premise admin clicks the install update button.

use_console_support_spec
boolean

Defines whether this license should use support bundle specs from console.

Response

UpdateLicenseResponse contains the license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Archive a license.

 
 Authentication is required for this endpoint.
deletehttps://api.replicated.com/vendor/v1/license/license_id
curl --request DELETE \
  --url https://api.replicated.com/vendor/v1/license/license_id
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.replicated.com/vendor/v1/license/license_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.replicated.com/vendor/v1/license/license_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update an airgap passsword.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/license/license_id/airgap/password
curl --request POST \
  --url https://api.replicated.com/vendor/v1/license/license_id/airgap/password
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/airgap/password' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/airgap/password")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/license/license_id/airgap/password");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/airgap/password"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

PostAirgapPasswordResponse contains the returned password

passwordstring

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update license billing information for a given licenseId.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/billing
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/billing
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/billing' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/billing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/billing");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/billing"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

begin
string
required

Begining date formated by year-month-day ex. 2016-02-02.

end
string
required

Ending date formated by year-month-day ex. 2016-02-02.

frequency
string
required

Can be set to Monthly, Quarterly, Annually, One Time, or Other to indicate interval that this billing happens.

license_type
string
required

LicenseType can be set to "dev", "trial", or "prod"

revenue
string
required

Amount of money associated with this billing event.

Response

UpdateLicenseBillingResponse contains the license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Create a license billing event.

 
 Authentication is required for this endpoint.
posthttps://api.replicated.com/vendor/v1/license/license_id/billing_event
curl --request POST \
  --url https://api.replicated.com/vendor/v1/license/license_id/billing_event
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/billing_event' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/billing_event")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.replicated.com/vendor/v1/license/license_id/billing_event");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/billing_event"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

amount
int64
required
description
string
required
vendor_due_from_customer_date
string
required
vendor_invoice_to_customer_date
string
required
vendor_paid_by_customer_date
string
required

Response

CreateLicenseBillingEventResponse contains the license billing event

LicenseBillingEventobject
LicenseBillingEvent.amountinteger
LicenseBillingEvent.descriptionstring
LicenseBillingEvent.event_datestring
LicenseBillingEvent.idstring
LicenseBillingEvent.vendor_due_from_customer_datestring
LicenseBillingEvent.vendor_invoice_to_customer_datestring
LicenseBillingEvent.vendor_paid_by_customer_datestring

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update a license billing event.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/billing_event/id
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/billing_event/id
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/billing_event/id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/billing_event/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/billing_event/id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/billing_event/id"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

id
string
required

Event ID

Body Params

amount
int64
required
description
string
required
vendor_due_from_customer_date
string
required
vendor_invoice_to_customer_date
string
required
vendor_paid_by_customer_date
string
required

Response

UpdateLicenseBillingEventResponse contains the resulting billing event

LicenseBillingEventobject
LicenseBillingEvent.amountinteger
LicenseBillingEvent.descriptionstring
LicenseBillingEvent.event_datestring
LicenseBillingEvent.idstring
LicenseBillingEvent.vendor_due_from_customer_datestring
LicenseBillingEvent.vendor_invoice_to_customer_datestring
LicenseBillingEvent.vendor_paid_by_customer_datestring

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update a license channel for a given license.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/channel
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/channel
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/channel' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/channel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/channel");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/channel"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

channel_id
string

Response

UpdateLicenseChannelResponse update channel response

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

/license/{license_id}/expire

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/expire
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/expire
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/expire' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/expire")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/expire");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/expire"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

expiration_date
string
required

Response

UpdateLicenseExpirationResponse contains the returned license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Set the value for a license field.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/field
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/field
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/field' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/field")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/field");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/field"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

field
string
required
value
string
required

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Get license field values for a given licenseId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/license/license_id/fields
curl --request GET \
  --url https://api.replicated.com/vendor/v1/license/license_id/fields
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/fields' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/license/license_id/fields");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/fields"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

GetLicenseFieldValuesResponse contains the field values

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Update license field values for a given licenseId.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/fields
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/fields
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/fields' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/fields")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/fields");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/fields"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Body Params

LicenseFieldValues
array of objects
required
field
value

Response

UpdateLicenseFieldsResponse contains the license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Get a license instance.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/license/license_id/instance/instance_id
curl --request GET \
  --url https://api.replicated.com/vendor/v1/license/license_id/instance/instance_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/instance/instance_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/instance/instance_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/license/license_id/instance/instance_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/instance/instance_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

instance_id
string
required

Instance identifier

Response

GetLicenseInstanceResponse contains the license instance

Licenseobject
License.Activeboolean
License.AppStatusstring
License.AssistSessionIdstring
License.Cloudstring
License.Createdstring
License.InstanceIdstring
License.LastActivestring
License.LicenseIdstring
License.ReplicatedAgentVersionstring
License.ReplicatedOperatorVersionstring
License.ReplicatedSyncTimestring
License.ReplicatedUiVersionstring
License.ReplicatedUpdaterVersionstring
License.ReplicatedVersionstring
License.VersionHistoryarray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Lists all tracked license instances for a given licenseId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/license/license_id/instances
curl --request GET \
  --url https://api.replicated.com/vendor/v1/license/license_id/instances
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/instances' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/instances")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/license/license_id/instances");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/instances"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

ListLicenseInstancesResponse contains the response license instances

ListInstancesarray

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Lists all untracked license instances for a given licenseId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/license/license_id/instances/untracked
curl --request GET \
  --url https://api.replicated.com/vendor/v1/license/license_id/instances/untracked
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/instances/untracked' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/instances/untracked")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/license/license_id/instances/untracked");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/instances/untracked"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

GetLicenseInstanceUntrackedResponse contains a list of untracked instances

Licenseobject
License.CurrentSequenceinteger
License.CurrentVersionstring
License.LicenseIdstring
License.ReplicatedAgentVersionstring
License.ReplicatedOperatorVersionstring
License.ReplicatedSyncTimestring
License.ReplicatedUiVersionstring
License.ReplicatedUpdaterVersionstring
License.ReplicatedVersionstring
License.SyncTimestring

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Revoke a license for a given licenseId.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/revoke
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/revoke
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/revoke' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/revoke")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/revoke");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/revoke"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

RevokeLicenseResponse contains the revoked license

Licenseobject
License.ActivationEmailstring
License.ActiveInstanceCountinteger
License.AirgapDownloadEnabledboolean
License.AirgapDownloadPasswordarray
License.Anonymousboolean
License.AppIdstring
License.AppStatusstring
License.Archivedboolean
License.Assigneestring
License.AssistedSetupEnabledboolean
License.Billingobject
License.Billing.beginstring
License.Billing.endstring
License.Billing.frequencystring
License.Billing.revenuestring
License.BillingEventsarray
License.ChannelIdstring
License.ChannelNamestring
License.Cloudsstring
License.ExpirationPolicystring
License.ExpireDatestring
License.ExternalSupportBundleboolean
License.FieldValuesarray
License.GrantDatestring
License.Idstring
License.InactiveInstanceCountinteger
License.IsAppVersionLockedboolean
License.IsInstanceTrackedboolean
License.LastSyncstring
License.LicenseTypestring
License.LicenseVersionsobject
License.LicenseVersions.InstalledAppVersionobject
License.LicenseVersions.InstalledAppVersion.Labelstring
License.LicenseVersions.InstalledAppVersion.LastCheckstring
License.LicenseVersions.InstalledAppVersion.Sequenceinteger
License.LicenseVersions.InstalledAppVersion.UpdateAvailableboolean
License.LicenseVersions.ReplicatedVersionsobject
License.LockedAppVersioninteger
License.RequireActivationboolean
License.RevokationDatestring
License.UntrackedInstanceCountinteger
License.UpdatePolicystring
License.UseConsoleSupportSpecboolean

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Unarchive a license.

 
 Authentication is required for this endpoint.
puthttps://api.replicated.com/vendor/v1/license/license_id/unarchive
curl --request PUT \
  --url https://api.replicated.com/vendor/v1/license/license_id/unarchive
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.replicated.com/vendor/v1/license/license_id/unarchive' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/license/license_id/unarchive")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.replicated.com/vendor/v1/license/license_id/unarchive");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/license/license_id/unarchive"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

On success, no payload returned

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found

Download app license (base64 deliverable to your end customer) key for a given licenseId.

 
 Authentication is required for this endpoint.
gethttps://api.replicated.com/vendor/v1/licensekey/license_id
curl --request GET \
  --url https://api.replicated.com/vendor/v1/licensekey/license_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.replicated.com/vendor/v1/licensekey/license_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.replicated.com/vendor/v1/licensekey/license_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.replicated.com/vendor/v1/licensekey/license_id");

xhr.send(data);
import requests

url = "https://api.replicated.com/vendor/v1/licensekey/license_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

license_id
string
required

License identifier

Response

DownloadLicenseResponse contains the licenses response

Returned on bad input

Return if the caller is not authorized

Returned if the caller does not have the needed permission

Returned on resource not found