API Documentation
This document describes the REST API for the service.
/api/v1/auth/api_keys
Authorized
Role: SUPER_USERClaim: CREATE_API_KEYClaim: LIST
This endpoint creates an api key
This endpoint will create an api key in the system
API Keys are used to authenticate with the system from external applications
How are they different from a user?
A user normally has a password and is used to authenticate with the system
An api key is used to authenticate with the system from an external application
Headers
Parameters
Name
Type
In
Required
Description
apiKeyobjectbody
optional
Body
Request examples
/v1/auth/api_keys
Authorized
curl --location 'http://localhost/api/v1/auth/api_keys'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{
"key": "Some Key",
"secret": "SomeLongSecret"
}
'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/api_keys" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/api_keys"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/api_keys
Authorized
Claim: LIST_API_KEY
This endpoint returns all the api keys
Request examples
/v1/auth/api_keys
Authorized
curl --location 'http://localhost/api/v1/auth/api_keys'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/api_keys" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/api_keys"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/api_keys/{id}
Authorized
Claim: DELETE_API_KEY
This endpoint deletes an api key
Parameters
Name
Type
In
Required
Description
idstringpath
required
Api Key ID
Request examples
/v1/auth/api_keys/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/api_keys/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/api_keys/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/api_keys/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/api_keys/{id}
Authorized
Claim: LIST_API_KEY
This endpoint returns an api key by id or name
Parameters
Name
Type
In
Required
Description
idstringpath
required
Api Key ID
Request examples
/v1/auth/api_keys/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/api_keys/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/api_keys/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/api_keys/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/api_keys/{id}/revoke
Authorized
Role: SUPER_USERClaim: LIST_API_KEYClaim: DELETE_API_KEY
This endpoint revokes an api key
Parameters
Name
Type
In
Required
Description
idstringpath
required
Api Key ID
Request examples
/v1/auth/api_keys/{id}/revoke
Authorized
curl --location 'http://localhost/api/v1/auth/api_keys/{id}/revoke'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/auth/api_keys/{id}/revoke" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/api_keys/{id}/revoke"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/token
Authorized
This endpoint generates a token
Parameters
Name
Type
In
Required
Description
loginobjectbody
optional
Body
Request examples
/v1/auth/token
Authorized
curl --location 'http://localhost/api/v1/auth/token'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/token" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/token"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/token/validate
Authorized
This endpoint validates a token
Parameters
Name
Type
In
Required
Description
tokenRequestobjectbody
optional
Body
Request examples
/v1/auth/token/validate
Authorized
curl --location 'http://localhost/api/v1/auth/token/validate'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/token/validate" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/token/validate"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/cache
Authorized
This endpoint returns all the remote catalog cache if any
Request examples
/v1/cache
Authorized
curl --location 'http://localhost/api/v1/cache'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/cache" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/cache"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/cache
Authorized
This endpoint returns all the remote catalog cache if any
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
Request examples
/v1/cache
Authorized
curl --location 'http://localhost/api/v1/cache'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/cache" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/cache"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/cache/{catalogId}
Authorized
This endpoint returns all the remote catalog cache if any and all its versions
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
Request examples
/v1/cache/{catalogId}
Authorized
curl --location 'http://localhost/api/v1/cache/{catalogId}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/cache/{catalogId}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/cache/{catalogId}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/cache/{catalogId}/{version}
Authorized
This endpoint deletes a version of a cache ite,
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
Request examples
/v1/cache/{catalogId}/{version}
Authorized
curl --location 'http://localhost/api/v1/cache/{catalogId}/{version}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/cache/{catalogId}/{version}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/cache/{catalogId}/{version}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog
Authorized
This endpoint returns all the remote catalogs
Request examples
/v1/catalog
Authorized
curl --location 'http://localhost/api/v1/catalog'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}
Authorized
This endpoint returns all the remote catalogs
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
Request examples
/v1/catalog/{catalogId}
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog/{catalogId}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}
Authorized
This endpoint returns a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
Request examples
/v1/catalog/{catalogId}/{version}
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog/{catalogId}/{version}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}
Authorized
This endpoint returns a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/download
Authorized
This endpoint downloads a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/download
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/download'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/download" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/download"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/taint
Authorized
This endpoint Taints a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/taint
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/taint'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Patch , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/taint" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/taint"
method := "patch"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/untaint
Authorized
This endpoint UnTaints a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/untaint
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/untaint'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Patch , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/untaint" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/untaint"
method := "patch"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/revoke
Authorized
This endpoint UnTaints a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/revoke
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/revoke'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Patch , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/revoke" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/revoke"
method := "patch"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/claims
Authorized
This endpoint adds claims to a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
requestobjectbody
optional
Body
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/claims
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Patch , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims"
method := "patch"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/claims
Authorized
This endpoint removes claims from a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
requestobjectbody
optional
Body
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/claims
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims"
method := "delete"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/roles
Authorized
This endpoint adds roles to a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
requestobjectbody
optional
Body
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/roles
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/roles'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Patch , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/roles" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/roles"
method := "patch"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/roles
Authorized
This endpoint removes roles from a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
requestobjectbody
optional
Body
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/roles
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/roles'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/roles" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/roles"
method := "delete"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}
Authorized
This endpoint deletes a catalog manifest and all its versions
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
Request examples
/v1/catalog/{catalogId}
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/catalog/{catalogId}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}
Authorized
This endpoint deletes a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
Request examples
/v1/catalog/{catalogId}/{version}
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/catalog/{catalogId}/{version}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}
Authorized
This endpoint deletes a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
versionstringpath
required
Version
architecturestringpath
required
Architecture
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/push
Authorized
This endpoint pushes a catalog manifest to the catalog inventory
Parameters
Name
Type
In
Required
Description
pushRequestobjectbody
optional
Push request
Request examples
/v1/catalog/push
Authorized
curl --location 'http://localhost/api/v1/catalog/push'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/catalog/push" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/push"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/push/async
Authorized
This endpoint pushes a catalog manifest to the catalog inventory in the background and returns a Job ID to track progress
Parameters
Name
Type
In
Required
Description
pushRequestobjectbody
optional
Push request
Request examples
/v1/catalog/push/async
Authorized
curl --location 'http://localhost/api/v1/catalog/push/async'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/catalog/push/async" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/push/async"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/pull
Authorized
This endpoint pulls a remote catalog manifest
Parameters
Name
Type
In
Required
Description
pullRequestobjectbody
optional
Pull request
Request examples
/v1/catalog/pull
Authorized
curl --location 'http://localhost/api/v1/catalog/pull'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/catalog/pull" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/pull"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/pull/async
Authorized
This endpoint pulls a remote catalog manifest in the background and returns a Job ID to track progress
Parameters
Name
Type
In
Required
Description
pullRequestobjectbody
optional
Pull request
Request examples
/v1/catalog/pull/async
Authorized
curl --location 'http://localhost/api/v1/catalog/pull/async'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/catalog/pull/async" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/pull/async"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/import
Authorized
This endpoint imports a remote catalog manifest metadata into the catalog inventory
Parameters
Name
Type
In
Required
Description
importRequestobjectbody
optional
Pull request
Request examples
/v1/catalog/import
Authorized
curl --location 'http://localhost/api/v1/catalog/import'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/catalog/import" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/import"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/import-vm
Authorized
This endpoint imports a virtual machine in pvm or macvm format into the catalog inventory generating the metadata for it
Parameters
Name
Type
In
Required
Description
importRequestobjectbody
optional
Vm Impoty request
Request examples
/v1/catalog/import-vm
Authorized
curl --location 'http://localhost/api/v1/catalog/import-vm'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/catalog/import-vm" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/import-vm"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog/{catalogId}/{version}/{architecture}/claims
Authorized
This endpoint adds claims to a catalog manifest version
Parameters
Name
Type
In
Required
Description
catalogIdstringpath
required
Catalog ID
requestobjectbody
optional
Body
Request examples
/v1/catalog/{catalogId}/{version}/{architecture}/claims
Authorized
curl --location 'http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Patch , "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog/{catalogId}/{version}/{architecture}/claims"
method := "patch"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog-managers
Authorized
This endpoint returns all the catalog managers
Request examples
/v1/catalog-managers
Authorized
curl --location 'http://localhost/api/v1/catalog-managers'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog-managers" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog-managers"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog-managers/{id}
Authorized
This endpoint returns a catalog manager
Parameters
Name
Type
In
Required
Description
idstringpath
required
Manager ID
Request examples
/v1/catalog-managers/{id}
Authorized
curl --location 'http://localhost/api/v1/catalog-managers/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/catalog-managers/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog-managers/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog-managers
Authorized
This endpoint creates a catalog manager
Request examples
/v1/catalog-managers
Authorized
curl --location 'http://localhost/api/v1/catalog-managers'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/catalog-managers" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog-managers"
method := "post"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog-managers/{id}
Authorized
This endpoint updates a catalog manager
Parameters
Name
Type
In
Required
Description
idstringpath
required
Manager ID
Request examples
/v1/catalog-managers/{id}
Authorized
curl --location 'http://localhost/api/v1/catalog-managers/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/catalog-managers/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog-managers/{id}"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/catalog-managers/{id}
Authorized
This endpoint deletes a catalog manager
Parameters
Name
Type
In
Required
Description
idstringpath
required
Manager ID
Request examples
/v1/catalog-managers/{id}
Authorized
curl --location 'http://localhost/api/v1/catalog-managers/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/catalog-managers/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/catalog-managers/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/claims
Authorized
This endpoint returns all the claims
Request examples
/v1/auth/claims
Authorized
curl --location 'http://localhost/api/v1/auth/claims'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/claims" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/claims"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/claims/grouped
Authorized
This endpoint returns all claims organised by group and resource
Request examples
/v1/auth/claims/grouped
Authorized
curl --location 'http://localhost/api/v1/auth/claims/grouped'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/claims/grouped" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/claims/grouped"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/claims/{id}
Authorized
This endpoint returns a claim
Parameters
Name
Type
In
Required
Description
idstringpath
required
Claim ID
Request examples
/v1/auth/claims/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/claims/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/claims/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/claims/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/claims
Authorized
This endpoint creates a claim
Parameters
Name
Type
In
Required
Description
claimRequestobjectbody
optional
Claim Request
Request examples
/v1/auth/claims
Authorized
curl --location 'http://localhost/api/v1/auth/claims'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/claims" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/claims"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/claims/{id}
Authorized
This endpoint Deletes a claim
Parameters
Name
Type
In
Required
Description
idstringpath
required
Claim ID
Request examples
/v1/auth/claims/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/claims/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/claims/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/claims/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/parallels_desktop/key
Authorized
This endpoint returns Parallels Desktop active license
Request examples
/v1/parallels_desktop/key
Authorized
curl --location 'http://localhost/api/v1/parallels_desktop/key'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/parallels_desktop/key" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/parallels_desktop/key"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/config/tools/install
Authorized
This endpoint installs API requires 3rd party tools
Parameters
Name
Type
In
Required
Description
installToolsRequestobjectbody
optional
Install Tools Request
Request examples
/v1/config/tools/install
Authorized
/api/v1/config/tools/uninstall
Authorized
This endpoint uninstalls API requires 3rd party tools
Parameters
Name
Type
In
Required
Description
uninstallToolsRequestobjectbody
optional
Uninstall Tools Request
Request examples
/v1/config/tools/uninstall
Authorized
/api/v1/config/tools/restart
Authorized
This endpoint restarts the API Service
Request examples
/v1/config/tools/restart
Authorized
/api/v1/config/hardware
Authorized
This endpoint returns the Hardware Info
Request examples
/v1/config/hardware
Authorized
curl --location 'http://localhost/api/v1/config/hardware'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/config/hardware" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/config/hardware"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/health/system
Authorized
This endpoint returns the API Health Probe
Parameters
Name
Type
In
Required
Description
fullqueryquery
optional
-
Request examples
/health/system
Authorized
curl --location 'http://localhost/api/health/system'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/health/system" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/health/system"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/logs
Authorized
This endpoint returns the system logs from the disk
Request examples
/logs
Authorized
curl --location 'http://localhost/api/logs'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/logs" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/logs"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/logs/stream
Authorized
This endpoint streams the system logs in real-time via WebSocket
Request examples
/logs/stream
Authorized
curl --location 'http://localhost/api/logs/stream'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/logs/stream" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/logs/stream"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/config/diskspace
Authorized
This endpoint returns the available disk space for the cache folder.
Parameters
Name
Type
In
Required
Description
createRequestobjectbody
optional
Disk Space Available Request
Request examples
/config/diskspace
Authorized
curl --location 'http://localhost/api/config/diskspace'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/config/diskspace" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/config/diskspace"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/ws/subscribe
Authorized
This endpoint upgrades the HTTP connection to WebSocket and subscribes to event notifications. Authentication is required via Authorization header (Bearer token) or query parameters (access_token or authorization).
Parameters
Name
Type
In
Required
Description
event_typesqueryquery
optional
-
Request examples
/v1/ws/subscribe
Authorized
curl --location 'http://localhost/api/v1/ws/subscribe'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/ws/subscribe" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/ws/subscribe"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/ws/clients
Authorized
Returns all currently connected WebSocket clients with queue depth and ping/pong timestamps. Useful for diagnosing stale or dead clients whose queues are filling up.
Request examples
/v1/ws/clients
Authorized
curl --location 'http://localhost/api/v1/ws/clients'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/ws/clients" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/ws/clients"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/ws/stats
Authorized
Returns aggregate statistics including total connected clients, subscription counts per event type, uptime, and per-client details with queue depths.
Request examples
/v1/ws/stats
Authorized
curl --location 'http://localhost/api/v1/ws/stats'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/ws/stats" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/ws/stats"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/ws/unsubscribe
Authorized
Unsubscribe an active WebSocket client from specific event types without disconnecting. The client must belong to the authenticated user.
Parameters
Name
Type
In
Required
Description
bodyobjectbody
optional
Unsubscribe request with client ID and event types
Request examples
/v1/ws/unsubscribe
Authorized
curl --location 'http://localhost/api/v1/ws/unsubscribe'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/ws/unsubscribe" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/ws/unsubscribe"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/jobs/{id}
Authorized
This endpoint deletes a single job. Users with JOB_MANAGER_DELETE can delete any job; users with JOB_MANAGER_LIST_OWN can only delete their own.
Parameters
Name
Type
In
Required
Description
idstringpath
required
Job ID
Request examples
/v1/jobs/{id}
Authorized
curl --location 'http://localhost/api/v1/jobs/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/jobs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/jobs/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines
Authorized
This endpoint returns all the virtual machines
Parameters
Name
Type
In
Required
Description
filterheaderheader
optional
-
Request examples
/v1/machines
Authorized
curl --location 'http://localhost/api/v1/machines'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/machines" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}
Authorized
This endpoint returns a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}
Authorized
curl --location 'http://localhost/api/v1/machines/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/machines/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/start
Authorized
This endpoint starts a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/start
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/start'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/start" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/start"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/stop
Authorized
This endpoint stops a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
forcequeryquery
optional
-
Request examples
/v1/machines/{id}/stop
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/stop'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/stop" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/stop"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/restart
Authorized
This endpoint restarts a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/restart
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/restart'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/restart" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/restart"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/suspend
Authorized
This endpoint suspends a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/suspend
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/suspend'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/suspend" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/suspend"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/resume
Authorized
This endpoint resumes a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/resume
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/resume'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/resume" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/resume"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/reset
Authorized
This endpoint reset a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/reset
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/reset'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/reset" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/reset"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/pause
Authorized
This endpoint pauses a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/pause
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/pause'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/pause" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/pause"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}
Authorized
This endpoint deletes a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}
Authorized
curl --location 'http://localhost/api/v1/machines/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/machines/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/status
Authorized
This endpoint returns the current state of a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/status
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/status'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/machines/{id}/status" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/status"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/set
Authorized
This endpoint configures a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
configRequestobjectbody
optional
Machine Set Request
Request examples
/v1/machines/{id}/set
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/set'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/set" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/set"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/clone
Authorized
This endpoint clones a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
configRequestobjectbody
optional
Machine Clone Request
Request examples
/v1/machines/{id}/clone
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/clone'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/clone" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/clone"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/execute
Authorized
This endpoint executes a command on a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
executeRequestobjectbody
optional
Machine Execute Command Request
Request examples
/v1/machines/{id}/execute
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/execute'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/execute" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/execute"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/upload
Authorized
This endpoint executes a command on a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
executeRequestobjectbody
optional
Machine Upload file Command Request
Request examples
/v1/machines/{id}/upload
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/upload'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines/{id}/upload" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/upload"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/rename
Authorized
This endpoint Renames a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
renameRequestobjectbody
optional
Machine Rename Request
Request examples
/v1/machines/{id}/rename
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/rename'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/machines/{id}/rename" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/rename"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/register
Authorized
This endpoint registers a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
registerRequestobjectbody
optional
Machine Register Request
Request examples
/v1/machines/register
Authorized
curl --location 'http://localhost/api/v1/machines/register'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines/register" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/register"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/unregister
Authorized
This endpoint unregister a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
unregisterRequestobjectbody
optional
Machine Unregister Request
Request examples
/v1/machines/{id}/unregister
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/unregister'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines/{id}/unregister" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/unregister"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines
Authorized
This endpoint creates a virtual machine
Parameters
Name
Type
In
Required
Description
createRequestobjectbody
optional
New Machine Request
Request examples
/v1/machines
Authorized
curl --location 'http://localhost/api/v1/machines'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/async
Authorized
This endpoint creates a virtual machine in the background and returns a Job ID to track progress
Parameters
Name
Type
In
Required
Description
createRequestobjectbody
optional
New Machine Request
Request examples
/v1/machines/async
Authorized
curl --location 'http://localhost/api/v1/machines/async'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines/async" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/async"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/snapshots
Authorized
This endpoint creates a snapshot for a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
createRequestobjectbody
optional
Create Snapshot Request
Request examples
/v1/machines/{id}/snapshots
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/snapshots'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines/{id}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/snapshots"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/snapshots/{snapshot_id}
Authorized
This endpoint deletes a snapshot of a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
snapshot_idstringpath
required
Snapshot ID
Request examples
/v1/machines/{id}/snapshots/{snapshot_id}
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/snapshots/{snapshot_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/machines/{id}/snapshots/{snapshot_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/snapshots/{snapshot_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/snapshots
Authorized
This endpoint deletes all snapshots of a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/snapshots
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/snapshots'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/machines/{id}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/snapshots"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/snapshots
Authorized
This endpoint lists snapshots of a virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
Request examples
/v1/machines/{id}/snapshots
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/snapshots'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/machines/{id}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/snapshots"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/machines/{id}/snapshots/{snapshot_id}/revert
Authorized
This endpoint reverts a virtual machine to a snapshot
Parameters
Name
Type
In
Required
Description
idstringpath
required
Machine ID
snapshot_idstringpath
required
Snapshot ID
revertRequestobjectbody
optional
Revert Snapshot Request
Request examples
/v1/machines/{id}/snapshots/{snapshot_id}/revert
Authorized
curl --location 'http://localhost/api/v1/machines/{id}/snapshots/{snapshot_id}/revert'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/machines/{id}/snapshots/{snapshot_id}/revert" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/machines/{id}/snapshots/{snapshot_id}/revert"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts
Authorized
This endpoint returns all hosts from the orchestrator
Request examples
/v1/orchestrator/hosts
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}
Authorized
This endpoint returns a host from the orchestrator
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/hardware
Authorized
This endpoint returns a host hardware info from the orchestrator
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/hardware
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/hardware'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/hardware" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/hardware"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts
Authorized
This endpoint register a host in the orchestrator
Parameters
Name
Type
In
Required
Description
hostRequestobjectbody
optional
Host Request
Request examples
/v1/orchestrator/hosts
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}
Authorized
This endpoint unregister a host from the orchestrator
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/enable
Authorized
This endpoint will enable an existing host in the orchestrator
Request examples
/v1/orchestrator/hosts/{id}/enable
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/enable'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/enable" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/enable"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/disable
Authorized
This endpoint will disable an existing host in the orchestrator
Request examples
/v1/orchestrator/hosts/{id}/disable
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/disable'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/disable" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/disable"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts
Authorized
This endpoint updates a host in the orchestrator
Parameters
Name
Type
In
Required
Description
hostRequestobjectbody
optional
Host Update Request
Request examples
/v1/orchestrator/hosts
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/overview/resources
Authorized
This endpoint returns orchestrator resource overview
Request examples
/v1/orchestrator/overview/resources
Authorized
curl --location 'http://localhost/api/v1/orchestrator/overview/resources'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/overview/resources" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/overview/resources"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/overview/{id}/resources
Authorized
This endpoint returns orchestrator host resources
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/overview/{id}/resources
Authorized
curl --location 'http://localhost/api/v1/orchestrator/overview/{id}/resources'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/overview/{id}/resources" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/overview/{id}/resources"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines
Authorized
This endpoint returns orchestrator Virtual Machines
Request examples
/v1/orchestrator/machines
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/machines" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}
Authorized
This endpoint returns orchestrator Virtual Machine by its ID
Request examples
/v1/orchestrator/machines/{id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/machines/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}
Authorized
This endpoint deletes orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
forcequeryquery
optional
-
Request examples
/v1/orchestrator/machines/{id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/machines/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/status
Authorized
This endpoint returns orchestrator virtual machine status
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/status
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/status'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/machines/{id}/status" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/status"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/rename
Authorized
This endpoint renames orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/rename
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/rename'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/rename" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/rename"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/set
Authorized
This endpoint configures orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/set
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/set'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/set" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/set"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/start
Authorized
This endpoint starts orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/start
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/start'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/start" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/start"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/stop
Authorized
This endpoint sops orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
forcequeryquery
optional
-
Request examples
/v1/orchestrator/machines/{id}/stop
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/stop'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/stop" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/stop"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/restart
Authorized
This endpoint restarts orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/restart
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/restart'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/restart" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/restart"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/suspend
Authorized
This endpoint suspends orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/suspend
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/suspend'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/suspend" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/suspend"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/resume
Authorized
This endpoint resumes orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/resume
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/resume'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/resume" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/resume"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/reset
Authorized
This endpoint resets orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/reset
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/reset'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/reset" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/reset"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/pause
Authorized
This endpoint pauses orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/pause
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/pause'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/pause" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/pause"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/clone
Authorized
This endpoint clones orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
configRequestobjectbody
optional
Machine Clone Request
Request examples
/v1/orchestrator/machines/{id}/clone
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/clone'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/clone" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/clone"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/execute
Authorized
This endpoint executes a command in a orchestrator virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/execute
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/execute'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/machines/{id}/execute" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/execute"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines
Authorized
This endpoint returns orchestrator host virtual machines
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/machines
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/machines" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}
Authorized
This endpoint returns orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}
Authorized
This endpoint deletes orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
forcequeryquery
optional
-
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/status
Authorized
This endpoint returns orchestrator host virtual machine status
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/status
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/status'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/status" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/status"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/rename
Authorized
This endpoint renames orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/rename
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/rename'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/rename" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/rename"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/set
Authorized
This endpoint configures orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/set
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/set'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/set" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/set"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/start
Authorized
This endpoint starts orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/start
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/start'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/start" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/start"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/stop
Authorized
This endpoint stops orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
forcequeryquery
optional
-
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/stop
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/stop'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/stop" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/stop"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/restart
Authorized
This endpoint restarts orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/restart
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/restart'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/restart" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/restart"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/suspend
Authorized
This endpoint suspends orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/suspend
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/suspend'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/suspend" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/suspend"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/resume
Authorized
This endpoint resumes orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/resume
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/resume'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/resume" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/resume"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/reset
Authorized
This endpoint resets orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/reset
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/reset'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/reset" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/reset"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/pause
Authorized
This endpoint pauses orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/pause
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/pause'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/pause" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/pause"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/clone
Authorized
This endpoint clones orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
configRequestobjectbody
optional
Machine Clone Request
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/clone
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/clone'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/clone" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/clone"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/execute
Authorized
This endpoint executes a command in a orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/execute
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/execute'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/execute" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/execute"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots
Authorized
This endpoint lists snapshots of orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots
Authorized
This endpoint creates a snapshot for orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
createRequestobjectbody
optional
Create Snapshot Request
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots
Authorized
This endpoint deletes all snapshots of orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}
Authorized
This endpoint deletes a snapshot of orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
snapshot_idstringpath
required
Snapshot ID
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}/revert
Authorized
This endpoint reverts orchestrator host virtual machine to a snapshot
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
snapshot_idstringpath
required
Snapshot ID
revertRequestobjectbody
optional
Revert Snapshot Request
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}/revert
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}/revert'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}/revert" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/snapshots/{snapshot_id}/revert"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/snapshots
Authorized
This endpoint lists snapshots of an orchestrator virtual machine (host resolved automatically)
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/snapshots
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/snapshots'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/machines/{id}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/snapshots"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/snapshots
Authorized
This endpoint creates a snapshot for an orchestrator virtual machine (host resolved automatically)
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
createRequestobjectbody
optional
Create Snapshot Request
Request examples
/v1/orchestrator/machines/{id}/snapshots
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/snapshots'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/machines/{id}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/snapshots"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/snapshots
Authorized
This endpoint deletes all snapshots of an orchestrator virtual machine (host resolved automatically)
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
Request examples
/v1/orchestrator/machines/{id}/snapshots
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/snapshots'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/machines/{id}/snapshots" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/snapshots"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}
Authorized
This endpoint deletes a snapshot of an orchestrator virtual machine (host resolved automatically)
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
snapshot_idstringpath
required
Snapshot ID
Request examples
/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}/revert
Authorized
This endpoint reverts an orchestrator virtual machine to a snapshot (host resolved automatically)
Parameters
Name
Type
In
Required
Description
idstringpath
required
Virtual Machine ID
snapshot_idstringpath
required
Snapshot ID
revertRequestobjectbody
optional
Revert Snapshot Request
Request examples
/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}/revert
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}/revert'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}/revert" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/{id}/snapshots/{snapshot_id}/revert"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/register
Authorized
This endpoint registers a virtual machine in a orchestrator host
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
requestobjectbody
optional
Register Virtual Machine Request
Request examples
/v1/orchestrator/hosts/{id}/machines/register
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/register'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/register" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/register"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/{vmId}/unregister
Authorized
This endpoint unregister a virtual machine in a orchestrator host
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
vmIdstringpath
required
Virtual Machine ID
requestobjectbody
optional
Register Virtual Machine Request
Request examples
/v1/orchestrator/hosts/{id}/machines/{vmId}/unregister
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/unregister'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/unregister" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/{vmId}/unregister"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines
Authorized
This endpoint creates a orchestrator host virtual machine
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
requestobjectbody
optional
Create Virtual Machine Request
Request examples
/v1/orchestrator/hosts/{id}/machines
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/machines" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines
Authorized
This endpoint creates a virtual machine in one of the hosts for the orchestrator
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Create Virtual Machine Request
Request examples
/v1/orchestrator/machines
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/machines" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy
Authorized
This endpoint returns orchestrator host reverse proxy configuration
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts
Authorized
This endpoint returns orchestrator host reverse proxy hosts
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}
Authorized
This endpoint returns orchestrator host reverse proxy hosts
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts
Authorized
This endpoint creates a orchestrator host reverse proxy host
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Create Host Reverse Proxy Host Request
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}
Authorized
This endpoint updates an orchestrator host reverse proxy host
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Update Host Reverse Proxy Host Request
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}
Authorized
This endpoint deletes an orchestrator host reverse proxy host
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
reverse_proxy_host_idstringpath
required
Reverse Proxy Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes
Authorized
This endpoint upserts an orchestrator host reverse proxy host http route
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Upsert Host Reverse Proxy Host Http Routes Request
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes/{route_id}
Authorized
This endpoint deletes an orchestrator host reverse proxy host http route
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
reverse_proxy_host_idstringpath
required
Reverse Proxy Host ID
route_idstringpath
required
Route ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes/{route_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes/{route_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes/{route_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/http_routes/{route_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/tcp_route
Authorized
This endpoint updates an orchestrator host reverse proxy host tcp route
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Update Host Reverse Proxy Host tcp Routes Request
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/tcp_route
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/tcp_route'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/tcp_route" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/hosts/{reverse_proxy_host_id}/tcp_route"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/restart
Authorized
This endpoint restarts orchestrator host reverse proxy
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/restart
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/restart'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/restart" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/restart"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/enable
Authorized
This endpoint enables orchestrator host reverse proxy
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/enable
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/enable'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/enable" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/enable"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/reverse-proxy/disable
Authorized
This endpoint disables orchestrator host reverse proxy
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/reverse-proxy/disable
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/disable'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/disable" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/reverse-proxy/disable"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/catalog/cache
Authorized
This endpoint returns orchestrator host catalog cache
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/catalog/cache
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/catalog/cache
Authorized
This endpoint deletes an orchestrator host cache items
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/catalog/cache
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}
Authorized
This endpoint deletes an orchestrator host cache item and all its children
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
catalog_idstringpath
required
Catalog ID
Request examples
/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}/{catalog_version}
Authorized
This endpoint deletes an orchestrator host cache item and all its children
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
catalog_idstringpath
required
Catalog ID
catalog_versionstringpath
required
Catalog Version
Request examples
/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}/{catalog_version}
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}/{catalog_version}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}/{catalog_version}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/catalog/cache/{catalog_id}/{catalog_version}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/logs
Authorized
This endpoint returns the orchestrator host system logs from the disk
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
Request examples
/v1/orchestrator/hosts/{id}/logs
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/logs'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/hosts/{id}/logs" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/logs"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/logs/stream
Authorized
This endpoint streams the system logs in real-time via WebSocket
Request examples
/logs/stream
Authorized
curl --location 'http://localhost/api/logs/stream'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/logs/stream" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/logs/stream"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/enrollment-token
Authorized
Generates a short-lived, single-use token that allows a freshly installed agent to register itself with the orchestrator without requiring a permanent credential.
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Enrollment token request
Request examples
/v1/orchestrator/enrollment-token
Authorized
curl --location 'http://localhost/api/v1/orchestrator/enrollment-token'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/enrollment-token" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/enrollment-token"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/enrollment-token/{token}/validate
Authorized
Public endpoint that checks whether an enrollment token is valid, unused, and not expired. Used by agents before starting the registration flow.
Parameters
Name
Type
In
Required
Description
tokenstringpath
required
Enrollment token value
Request examples
/v1/orchestrator/enrollment-token/{token}/validate
Authorized
curl --location 'http://localhost/api/v1/orchestrator/enrollment-token/{token}/validate'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/orchestrator/enrollment-token/{token}/validate" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/enrollment-token/{token}/validate"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/deploy
Authorized
SSHes into a remote host, installs the devops agent, and registers it with this orchestrator. Blocks until the operation completes.
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Deploy request
Request examples
/v1/orchestrator/hosts/deploy
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/deploy'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/deploy" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/deploy"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/deploy/async
Authorized
SSHes into a remote host, installs the devops agent, and registers it with this orchestrator. Returns a job ID immediately; poll /jobs/{id} for status.
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Deploy request
Request examples
/v1/orchestrator/hosts/deploy/async
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/deploy/async'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/deploy/async" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/deploy/async"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/machines/async
Authorized
This endpoint creates a virtual machine in one of the orchestrator hosts in the background and returns a Job ID to track progress
Parameters
Name
Type
In
Required
Description
requestobjectbody
optional
Create Virtual Machine Request
Request examples
/v1/orchestrator/machines/async
Authorized
curl --location 'http://localhost/api/v1/orchestrator/machines/async'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/machines/async" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/machines/async"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/orchestrator/hosts/{id}/machines/async
Authorized
This endpoint creates a virtual machine in a specific orchestrator host in the background and returns a Job ID to track progress
Parameters
Name
Type
In
Required
Description
idstringpath
required
Host ID
requestobjectbody
optional
Create Virtual Machine Request
Request examples
/v1/orchestrator/hosts/{id}/machines/async
Authorized
curl --location 'http://localhost/api/v1/orchestrator/hosts/{id}/machines/async'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/orchestrator/hosts/{id}/machines/async" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/orchestrator/hosts/{id}/machines/async"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/templates/packer
Authorized
This endpoint returns all the packer templates. **DEPRECATED:** This endpoint will be deprecated in the future, please upgrade your calls to use the catalog service, see https://parallels.github.io/prl-devops-service/docs/devops/catalog/overview/
Request examples
/v1/templates/packer
Authorized
curl --location 'http://localhost/api/v1/templates/packer'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/templates/packer" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/templates/packer"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/templates/packer/{id}
Authorized
This endpoint returns a packer template. **DEPRECATED:** This endpoint will be deprecated in the future, please upgrade your calls to use the catalog service, see https://parallels.github.io/prl-devops-service/docs/devops/catalog/overview/
Parameters
Name
Type
In
Required
Description
idstringpath
required
Packer Template ID
Request examples
/v1/templates/packer/{id}
Authorized
curl --location 'http://localhost/api/v1/templates/packer/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/templates/packer/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/templates/packer/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/templates/packer
Authorized
This endpoint creates a packer template. **DEPRECATED:** This endpoint will be deprecated in the future, please upgrade your calls to use the catalog service, see https://parallels.github.io/prl-devops-service/docs/devops/catalog/overview/
Parameters
Name
Type
In
Required
Description
createPackerTemplateRequestobjectbody
optional
Create Packer Template Request
Request examples
/v1/templates/packer
Authorized
curl --location 'http://localhost/api/v1/templates/packer '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/templates/packer " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/templates/packer "
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/templates/packer/{id}
Authorized
This endpoint updates a packer template. **DEPRECATED:** This endpoint will be deprecated in the future, please upgrade your calls to use the catalog service, see https://parallels.github.io/prl-devops-service/docs/devops/catalog/overview/
Parameters
Name
Type
In
Required
Description
createPackerTemplateRequestobjectbody
optional
Update Packer Template Request
idstringpath
required
Packer Template ID
Request examples
/v1/templates/packer/{id}
Authorized
curl --location 'http://localhost/api/v1/templates/packer/{id} '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/templates/packer/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/templates/packer/{id} "
method := "PUT"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/templates/packer/{id}
Authorized
This endpoint deletes a packer template. **DEPRECATED:** This endpoint will be deprecated in the future, please upgrade your calls to use the catalog service, see https://parallels.github.io/prl-devops-service/docs/devops/catalog/overview/
Parameters
Name
Type
In
Required
Description
idstringpath
required
Packer Template ID
Request examples
/v1/templates/packer/{id}
Authorized
curl --location 'http://localhost/api/v1/templates/packer/{id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/templates/packer/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/templates/packer/{id} "
method := "DELETE"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy
Authorized
This endpoint returns the reverse proxy configuration
Request examples
/v1/reverse-proxy
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/reverse-proxy" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts
Authorized
This endpoint returns all the reverse proxy hosts
Request examples
/v1/reverse-proxy/hosts
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/reverse-proxy/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}
Authorized
This endpoint returns a reverse proxy host
Parameters
Name
Type
In
Required
Description
idstringpath
required
Reverse Proxy Host ID
Request examples
/v1/reverse-proxy/hosts/{id}
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/reverse-proxy/hosts/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id} "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts
Authorized
This endpoint creates a reverse proxy host
Parameters
Name
Type
In
Required
Description
reverse_proxy_create_requestobjectbody
optional
Reverse Host Request
Request examples
/v1/reverse-proxy/hosts
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/reverse-proxy/hosts" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}
Authorized
This endpoint creates a reverse proxy host
Parameters
Name
Type
In
Required
Description
reverse_proxy_update_requestobjectbody
optional
Reverse Host Request
Request examples
/v1/reverse-proxy/hosts/{id}
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id}'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/reverse-proxy/hosts/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id}"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}
Authorized
This endpoint Deletes a reverse proxy host
Parameters
Name
Type
In
Required
Description
idstringpath
required
Reverse Proxy Host ID
Request examples
/v1/reverse-proxy/hosts/{id}
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/reverse-proxy/hosts/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}/http_route
Authorized
This endpoint creates or updates a reverse proxy host HTTP route
Parameters
Name
Type
In
Required
Description
reverse_proxy_http_route_requestobjectbody
optional
Reverse Host Request
Request examples
/v1/reverse-proxy/hosts/{id}/http_route
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id}/http_route'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_route" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_route"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}/http_routes/{http_route_id}
Authorized
This endpoint Deletes a reverse proxy host HTTP route
Parameters
Name
Type
In
Required
Description
idstringpath
required
Reverse Proxy Host ID
http_route_idstringpath
required
Reverse Proxy Host HTTP Route ID
Request examples
/v1/reverse-proxy/hosts/{id}/http_routes/{http_route_id}
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes/{http_route_id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes/{http_route_id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes/{http_route_id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}/http_routes/order
Authorized
This endpoint reorders HTTP routes for a reverse proxy host
Parameters
Name
Type
In
Required
Description
idstringpath
required
Reverse Proxy Host ID
reverse_proxy_http_route_reorder_requestobjectbody
optional
Reverse Proxy Host HTTP Route Reorder Request
Request examples
/v1/reverse-proxy/hosts/{id}/http_routes/order
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes/order'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes/order" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes/order"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/hosts/{id}/http_routes
Authorized
This endpoint updates a reverse proxy host TCP route
Parameters
Name
Type
In
Required
Description
reverse_proxy_tcp_route_requestobjectbody
optional
Reverse Host Request
Request examples
/v1/reverse-proxy/hosts/{id}/http_routes
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/hosts/{id}/http_routes"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/restart
Authorized
This endpoint will restart the reverse proxy
Request examples
/v1/reverse-proxy/restart
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/restart'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/reverse-proxy/restart" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/restart"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/enable
Authorized
This endpoint will enable the reverse proxy
Request examples
/v1/reverse-proxy/enable
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/enable'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/reverse-proxy/enable" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/enable"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/reverse-proxy/disable
Authorized
This endpoint will disable the reverse proxy
Request examples
/v1/reverse-proxy/disable
Authorized
curl --location 'http://localhost/api/v1/reverse-proxy/disable'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/reverse-proxy/disable" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/reverse-proxy/disable"
method := "put"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles
Authorized
This endpoint returns all the roles
Request examples
/v1/auth/roles
Authorized
curl --location 'http://localhost/api/v1/auth/roles '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/roles " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles/{id}
Authorized
This endpoint returns a role
Parameters
Name
Type
In
Required
Description
idstringpath
required
Role ID
Request examples
/v1/auth/roles/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/roles/{id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/roles/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles/{id} "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles
Authorized
This endpoint creates a role
Parameters
Name
Type
In
Required
Description
roleRequestobjectbody
optional
Role Request
Request examples
/v1/auth/roles
Authorized
curl --location 'http://localhost/api/v1/auth/roles '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/roles " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles "
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles/{id}
Authorized
This endpoint deletes a role
Parameters
Name
Type
In
Required
Description
idstringpath
required
Role ID
Request examples
/v1/auth/roles/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/roles/{id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/roles/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles/{id} "
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles/{id}/claims
Authorized
This endpoint returns all claims associated with a role
Parameters
Name
Type
In
Required
Description
idstringpath
required
Role ID
Request examples
/v1/auth/roles/{id}/claims
Authorized
curl --location 'http://localhost/api/v1/auth/roles/{id}/claims '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/roles/{id}/claims " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles/{id}/claims "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles/{id}/claims
Authorized
This endpoint adds a claim to a role
Parameters
Name
Type
In
Required
Description
idstringpath
required
Role ID
bodyobjectbody
optional
Claim Name
Request examples
/v1/auth/roles/{id}/claims
Authorized
curl --location 'http://localhost/api/v1/auth/roles/{id}/claims '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/roles/{id}/claims " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles/{id}/claims "
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/roles/{id}/claims/{claim_id}
Authorized
This endpoint removes a claim from a role
Parameters
Name
Type
In
Required
Description
idstringpath
required
Role ID
claim_idstringpath
required
Claim ID
Request examples
/v1/auth/roles/{id}/claims/{claim_id}
Authorized
curl --location 'http://localhost/api/v1/auth/roles/{id}/claims/{claim_id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/roles/{id}/claims/{claim_id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/roles/{id}/claims/{claim_id} "
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/ssh/execute
Authorized
Executes a command on a remote host via SSH
Parameters
Name
Type
In
Required
Description
sshRequestobjectbody
optional
Body
Schema
{
"command" : "string" ,
"enable_insecure_key" : "bool" ,
"host" : "string" ,
"key" : "string" ,
"password" : "string" ,
"port" : "int" ,
"username" : "string"
}
Request examples
/v1/ssh/execute
Authorized
curl --location 'http://localhost/api/v1/ssh/execute'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{
"command": "string",
"enable_insecure_key": "bool",
"host": "string",
"key": "string",
"password": "string",
"port": "int",
"username": "string"
}'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/ssh/execute" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{
"command" : "string" ,
"enable_insecure_key" : "bool" ,
"host" : "string" ,
"key" : "string" ,
"password" : "string" ,
"port" : "int" ,
"username" : "string"
} ");
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/ssh/execute"
method := "post"
payload := strings . NewReader ( `{
"command": "string",
"enable_insecure_key": "bool",
"host": "string",
"key": "string",
"password": "string",
"port": "int",
"username": "string"
}` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
Responses
{
"error" : "string" ,
"output" : "string"
}
/api/v1/user/configs
Authorized
This endpoint returns all configuration entries for the authenticated user
Request examples
/v1/user/configs
Authorized
curl --location 'http://localhost/api/v1/user/configs'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/user/configs" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs/{id}
Authorized
This endpoint returns a single configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
idstringpath
required
Config ID or Slug
Request examples
/v1/user/configs/{id}
Authorized
curl --location 'http://localhost/api/v1/user/configs/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/user/configs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs/{id}"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs
Authorized
This endpoint creates a configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
userConfigobjectbody
optional
Body
Request examples
/v1/user/configs
Authorized
curl --location 'http://localhost/api/v1/user/configs'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/user/configs" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs"
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs/{id}
Authorized
This endpoint updates a configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
idstringpath
required
Config ID or Slug
userConfigobjectbody
optional
Body
Request examples
/v1/user/configs/{id}
Authorized
curl --location 'http://localhost/api/v1/user/configs/{id}'
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/user/configs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs/{id}"
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/user/configs/{id}
Authorized
This endpoint deletes a configuration entry for the authenticated user
Parameters
Name
Type
In
Required
Description
idstringpath
required
Config ID or Slug
Request examples
/v1/user/configs/{id}
Authorized
curl --location 'http://localhost/api/v1/user/configs/{id}'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/user/configs/{id}" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/user/configs/{id}"
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users
Authorized
This endpoint returns all the users
Request examples
/v1/auth/users
Authorized
curl --location 'http://localhost/api/v1/auth/users '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/users " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}
Authorized
This endpoint returns a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
Request examples
/v1/auth/users/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/users/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id} "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users
Authorized
This endpoint creates a user
Parameters
Name
Type
In
Required
Description
bodyobjectbody
optional
User
Request examples
/v1/auth/users
Authorized
curl --location 'http://localhost/api/v1/auth/users '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/users " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users "
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}
Authorized
This endpoint deletes a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
Request examples
/v1/auth/users/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/users/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id} "
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}
Authorized
This endpoint updates a user
Parameters
Name
Type
In
Required
Description
bodyobjectbody
optional
User
Request examples
/v1/auth/users/{id}
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id} '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Put , "http://localhost/api/v1/auth/users/{id} " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id} "
method := "put"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}/roles
Authorized
This endpoint returns all the roles for a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
Request examples
/v1/auth/users/{id}/roles
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id}/roles '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/users/{id}/roles " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id}/roles "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}/roles
Authorized
This endpoint adds a role to a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
bodyobjectbody
optional
Role Name
Request examples
/v1/auth/users/{id}/roles
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id}/roles '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/users/{id}/roles " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id}/roles "
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}/roles/{role_id}
Authorized
This endpoint removes a role from a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
role_idstringpath
required
Role ID
Request examples
/v1/auth/users/{id}/roles/{role_id}
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id}/roles/{role_id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/users/{id}/roles/{role_id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id}/roles/{role_id} "
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}/claims
Authorized
This endpoint returns all the claims for a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
Request examples
/v1/auth/users/{id}/claims
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id}/claims '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/v1/auth/users/{id}/claims " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id}/claims "
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}/claims
Authorized
This endpoint adds a claim to a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
bodyobjectbody
optional
Claim Name
Request examples
/v1/auth/users/{id}/claims
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id}/claims '
--header 'Authorization ••••••'
--header 'Content-Type: application/json'
--data '{ object }'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Post , "http://localhost/api/v1/auth/users/{id}/claims " );
request . Headers . Add ( "Authorization" , "••••••" );
request . Headers . Add ( "Content-Type" , "application/json" );
request . Content = new StringContent ( "{ object }" );
request . Content = content ;
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id}/claims "
method := "post"
payload := strings . NewReader ( `{ object }` )
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/v1/auth/users/{id}/claims/{claim_id}
Authorized
This endpoint removes a claim from a user
Parameters
Name
Type
In
Required
Description
idstringpath
required
User ID
claim_idstringpath
required
Claim ID
Request examples
/v1/auth/users/{id}/claims/{claim_id}
Authorized
curl --location 'http://localhost/api/v1/auth/users/{id}/claims/{claim_id} '
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Delete , "http://localhost/api/v1/auth/users/{id}/claims/{claim_id} " );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/v1/auth/users/{id}/claims/{claim_id} "
method := "delete"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
/api/health/probe
Authorized
This endpoint returns the API Health Probe
Request examples
/health/probe
Authorized
curl --location 'http://localhost/api/health/probe'
--header 'Authorization ••••••'
var client = new HttpClient ();
var request = new HttpRequestMessage ( HttpMethod . Get , "http://localhost/api/health/probe" );
request . Headers . Add ( "Authorization" , "••••••" );
var response = await client . SendAsync ( request );
response . EnsureSuccessStatusCode ();
var responseString = await response . Content . ReadAsStringAsync ();
package main
import (
"fmt"
"net/http"
"strings"
"io"
)
func main () {
url := "http://localhost/api/health/probe"
method := "get"
client := & http . Client {}
req , err := http . NewRequest ( method , url , payload )
if err != nil {
fmt . Println ( err )
return
}
req . Header . Add ( "Content-Type" , "application/json" )
req . Header . Add ( "Authorization" , "••••••" )
res , err := client . Do ( req )
if err != nil {
fmt . Println ( err )
return
}
defer res . Body . Close ()
body , err := io . ReadAll ( res . Body )
if err != nil {
fmt . Println ( err )
return
}
fmt . Println ( string ( body ))
}
Responses
{
"additionalProp1" : "string" ,
"additionalProp2" : "string" ,
"additionalProp3" : "string"
}
