Invary Runtime Integrity

Appraisal

getAppraisalReport

Get Appraisal Report

Retrieves the report of an appraisal by id


/org/{orgId}/appraisal/{appraisalId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
 -H "Accept: application/json"\
 "https://api.invary.com/api/org/{orgId}/appraisal/{appraisalId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AppraisalApi;

import java.io.File;
import java.util.*;

public class AppraisalApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearer_token
        HttpBearerAuth bearer_token = (HttpBearerAuth) defaultClient.getAuthentication("bearer_token");
        bearer_token.setBearerToken("BEARER TOKEN");
        
        // Create an instance of the API class
        AppraisalApi apiInstance = new AppraisalApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String appraisalId = yfbq34r59aq1a83usemkvzmtk; // String | Id of the appraisal to retrieve
        
        try {
            AppraisalReport result = apiInstance.getAppraisalReport(orgId, appraisalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppraisalApi#getAppraisalReport");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AppraisalApi;

public class AppraisalApiExample {
    public static void main(String[] args) {
        AppraisalApi apiInstance = new AppraisalApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String appraisalId = yfbq34r59aq1a83usemkvzmtk; // String | Id of the appraisal to retrieve
        
        try {
            AppraisalReport result = apiInstance.getAppraisalReport(orgId, appraisalId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppraisalApi#getAppraisalReport");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearer_token
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AppraisalApi *apiInstance = [[AppraisalApi alloc] init];
String *orgId = 6ph6yrsfsavua4wu57zff5hb3; // Id of the owning organization (default to null)
String *appraisalId = yfbq34r59aq1a83usemkvzmtk; // Id of the appraisal to retrieve (default to null)

// Get Appraisal Report
[apiInstance getAppraisalReportWith:orgId
    appraisalId:appraisalId
              completionHandler: ^(AppraisalReport output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var InvaryRuntimeIntegrity = require('invary_runtime_integrity');
var defaultClient = InvaryRuntimeIntegrity.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearer_token
var bearer_token = defaultClient.authentications['bearer_token'];
bearer_token.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new InvaryRuntimeIntegrity.AppraisalApi()
var orgId = 6ph6yrsfsavua4wu57zff5hb3; // {String} Id of the owning organization
var appraisalId = yfbq34r59aq1a83usemkvzmtk; // {String} Id of the appraisal to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppraisalReport(orgId, appraisalId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getAppraisalReportExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearer_token
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new AppraisalApi();
            var orgId = 6ph6yrsfsavua4wu57zff5hb3;  // String | Id of the owning organization (default to null)
            var appraisalId = yfbq34r59aq1a83usemkvzmtk;  // String | Id of the appraisal to retrieve (default to null)

            try {
                // Get Appraisal Report
                AppraisalReport result = apiInstance.getAppraisalReport(orgId, appraisalId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AppraisalApi.getAppraisalReport: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearer_token
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AppraisalApi();
$orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
$appraisalId = yfbq34r59aq1a83usemkvzmtk; // String | Id of the appraisal to retrieve

try {
    $result = $api_instance->getAppraisalReport($orgId, $appraisalId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppraisalApi->getAppraisalReport: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AppraisalApi;

# Configure Bearer (JWT) access token for authorization: bearer_token
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AppraisalApi->new();
my $orgId = 6ph6yrsfsavua4wu57zff5hb3; # String | Id of the owning organization
my $appraisalId = yfbq34r59aq1a83usemkvzmtk; # String | Id of the appraisal to retrieve

eval { 
    my $result = $api_instance->getAppraisalReport(orgId => $orgId, appraisalId => $appraisalId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppraisalApi->getAppraisalReport: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearer_token
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AppraisalApi()
orgId = 6ph6yrsfsavua4wu57zff5hb3 # String | Id of the owning organization (default to null)
appraisalId = yfbq34r59aq1a83usemkvzmtk # String | Id of the appraisal to retrieve (default to null)

try: 
    # Get Appraisal Report
    api_response = api_instance.get_appraisal_report(orgId, appraisalId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppraisalApi->getAppraisalReport: %s\n" % e)
extern crate AppraisalApi;

pub fn main() {
    let orgId = 6ph6yrsfsavua4wu57zff5hb3; // String
    let appraisalId = yfbq34r59aq1a83usemkvzmtk; // String

    let mut context = AppraisalApi::Context::default();
    let result = client.getAppraisalReport(orgId, appraisalId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
orgId*
String (invaryId)

Id of the owning organization

Required
appraisalId*
String (invaryId)

Id of the appraisal to retrieve

Required

Responses

Status: 200 - Successful operation

{

The findings of an appraisal on an endpoint

id:
string (invaryId)

Id of the appraisal report

Example: mh02ckw0e10kczu7adkz0r5yp
organization:
string (invaryId)

Id of the organization that owns the appraisal report

Example: 8z2xfqppx4xfa0fnm40ee063d
created:
string (date-time)

Date and time when the appraisal report was created

Example: 2023-07-05T21:47:55.264395Z
status:
string

Status of the appraisal report

Example: SUCCESSFUL
Enum: UNKNOWN, SUCCESSFUL, FAILED, ERRORED
passed:
[

The set of appraisal areas that passed

string

A passing appraisal area

]
failed:
[

The set of appraisal areas that failed

string

A failing appraisal area

]
measurement:
{

Information about the measurement that an appraisal was based upon

nodes:
integer

Number of kernel graph nodes in the measurement

edges:
integer

Number of kernel graph edges in the measurement

modules:
integer

Number of kernel loadable modules in the measurement

Example: 
{
    "nodes": 101623,
    "edges": 355197,
    "modules": 52
}
kernel:
{

Information about the operating system kernel that was appraised

name:
string

Operating system kernel name

release:
string

Operating system kernel release

version:
string

Operating system kernel version

Example: 
{
    "name": "Linux",
    "release": "5.15.0-67-generic",
    "version": "#74~20.04.1-Ubuntu SMP Wed Feb 22 14:52:34 UTC 2023"
}
node:
{

Additional information about the endpoint

processor:
string

Endpoint processor family

name:
string

Endpoint hostname

uptime:
integer

Endpoint uptime in seconds

tags:
[

The set of tags applied to this endpoint

string

A tag that has been applied to this endpoint

]
Example: 
{
    "processor": "x86_64",
    "name": "ubuntu-20-04",
    "uptime": 692,
    "tags": [
        "tag1",
        "tag2"
    ]
}
distribution:
{

Information about the operating system distribution that was appraised

vendor:
string

Operating system distribution vendor

release:
string

Operating system distribution release

codename:
string

Operating system distribution code name for the release

Example: 
{
    "vendor": "Ubuntu",
    "release": 20.04,
    "codename": "focal"
}
endpoint:
string (invaryId)

Id of the endpoint that was appraised

Example: dqcam653hsdrd2g31qnsqy6ak
checks:
[

The set of checks performed during this appraisal

{

A check that was performed as part of an appraisal

name:
string

The name of the check

Example: function.pointers
result:
string

Outcome of the check

Example: SUCCESSFUL
Enum: UNKNOWN, SUCCESSFUL, FAILED, ERRORED
failureDetails:
[
{

Detailed information about an unsuccessful check performed during an appraisal

atNode:
string

Location of the failure

reason:
string

Reason for the failure

value:
[

Values related to the failure

string
]
Example: 
{
    "atNode": "sys_call_table",
    "reason": "Matching sys_call_table entry could not be found in baseline",
    "value": [
        "Missing kernel__x64_sys_read, found rogue:840 instead.",
        "Missing kernel__x64_sys_open, found rogue:460 instead.",
        "Missing kernel__x64_sys_close, found rogue:90 instead.",
        "Missing kernel__x64_sys_kill, found rogue:19d4 instead.",
        "Missing kernel__x64_sys_getdents, found rogue:560 instead.",
        "Missing kernel__x64_sys_getdents64, found rogue:9a0 instead.",
        "Missing kernel__x64_sys_openat, found rogue:3c0 instead."
    ]
}
]
Example: 
{
    "name": "jump.tables,",
    "result": "FAILED,",
    "failureDetails": [
        {
            "atNode": "sys_call_table",
            "reason": "Matching sys_call_table entry could not be found in baseline",
            "value": [
                "Missing kernel__x64_sys_read, found rogue:840 instead.",
                "Missing kernel__x64_sys_open, found rogue:460 instead.",
                "Missing kernel__x64_sys_close, found rogue:90 instead.",
                "Missing kernel__x64_sys_kill, found rogue:19d4 instead.",
                "Missing kernel__x64_sys_getdents, found rogue:560 instead.",
                "Missing kernel__x64_sys_getdents64, found rogue:9a0 instead.",
                "Missing kernel__x64_sys_openat, found rogue:3c0 instead."
            ]
        }
    ]
}
]

listAppraisals

List Appraisals

Lists the appraisals under the given organization.


/org/{orgId}/appraisal

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
 -H "Accept: application/json"\
 "https://api.invary.com/api/org/{orgId}/appraisal?page_size=&sort=&offset="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AppraisalApi;

import java.io.File;
import java.util.*;

public class AppraisalApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearer_token
        HttpBearerAuth bearer_token = (HttpBearerAuth) defaultClient.getAuthentication("bearer_token");
        bearer_token.setBearerToken("BEARER TOKEN");
        
        // Create an instance of the API class
        AppraisalApi apiInstance = new AppraisalApi();
        String orgId = orgId_example; // String | Id of the owning organization
        Integer pageSize = 56; // Integer | Maximum number of appraisals to return per page
        String sort = -status; // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
        String offset = offset_example; // String | Offset key from the previous page of results
        
        try {
            AppraisalList result = apiInstance.listAppraisals(orgId, pageSize, sort, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppraisalApi#listAppraisals");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AppraisalApi;

public class AppraisalApiExample {
    public static void main(String[] args) {
        AppraisalApi apiInstance = new AppraisalApi();
        String orgId = orgId_example; // String | Id of the owning organization
        Integer pageSize = 56; // Integer | Maximum number of appraisals to return per page
        String sort = -status; // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
        String offset = offset_example; // String | Offset key from the previous page of results
        
        try {
            AppraisalList result = apiInstance.listAppraisals(orgId, pageSize, sort, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppraisalApi#listAppraisals");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearer_token
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
AppraisalApi *apiInstance = [[AppraisalApi alloc] init];
String *orgId = orgId_example; // Id of the owning organization (default to null)
Integer *pageSize = 56; // Maximum number of appraisals to return per page (optional) (default to 25)
String *sort = -status; // Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order. (optional) (default to -created)
String *offset = offset_example; // Offset key from the previous page of results (optional) (default to null)

// List Appraisals
[apiInstance listAppraisalsWith:orgId
    pageSize:pageSize
    sort:sort
    offset:offset
              completionHandler: ^(AppraisalList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var InvaryRuntimeIntegrity = require('invary_runtime_integrity');
var defaultClient = InvaryRuntimeIntegrity.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearer_token
var bearer_token = defaultClient.authentications['bearer_token'];
bearer_token.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new InvaryRuntimeIntegrity.AppraisalApi()
var orgId = orgId_example; // {String} Id of the owning organization
var opts = {
  'pageSize': 56, // {Integer} Maximum number of appraisals to return per page
  'sort': -status, // {String} Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
  'offset': offset_example // {String} Offset key from the previous page of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listAppraisals(orgId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listAppraisalsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearer_token
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new AppraisalApi();
            var orgId = orgId_example;  // String | Id of the owning organization (default to null)
            var pageSize = 56;  // Integer | Maximum number of appraisals to return per page (optional)  (default to 25)
            var sort = -status;  // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order. (optional)  (default to -created)
            var offset = offset_example;  // String | Offset key from the previous page of results (optional)  (default to null)

            try {
                // List Appraisals
                AppraisalList result = apiInstance.listAppraisals(orgId, pageSize, sort, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AppraisalApi.listAppraisals: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearer_token
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AppraisalApi();
$orgId = orgId_example; // String | Id of the owning organization
$pageSize = 56; // Integer | Maximum number of appraisals to return per page
$sort = -status; // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
$offset = offset_example; // String | Offset key from the previous page of results

try {
    $result = $api_instance->listAppraisals($orgId, $pageSize, $sort, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppraisalApi->listAppraisals: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::AppraisalApi;

# Configure Bearer (JWT) access token for authorization: bearer_token
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::AppraisalApi->new();
my $orgId = orgId_example; # String | Id of the owning organization
my $pageSize = 56; # Integer | Maximum number of appraisals to return per page
my $sort = -status; # String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
my $offset = offset_example; # String | Offset key from the previous page of results

eval { 
    my $result = $api_instance->listAppraisals(orgId => $orgId, pageSize => $pageSize, sort => $sort, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppraisalApi->listAppraisals: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearer_token
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.AppraisalApi()
orgId = orgId_example # String | Id of the owning organization (default to null)
pageSize = 56 # Integer | Maximum number of appraisals to return per page (optional) (default to 25)
sort = -status # String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order. (optional) (default to -created)
offset = offset_example # String | Offset key from the previous page of results (optional) (default to null)

try: 
    # List Appraisals
    api_response = api_instance.list_appraisals(orgId, pageSize=pageSize, sort=sort, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AppraisalApi->listAppraisals: %s\n" % e)
extern crate AppraisalApi;

pub fn main() {
    let orgId = orgId_example; // String
    let pageSize = 56; // Integer
    let sort = -status; // String
    let offset = offset_example; // String

    let mut context = AppraisalApi::Context::default();
    let result = client.listAppraisals(orgId, pageSize, sort, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
orgId*
String (invaryId)

Id of the owning organization

Required
Query parameters
Name Description
page_size
Integer

Maximum number of appraisals to return per page
sort
String

Sort order to be applied to results. The value is in the form of +/- + field where field is one of [id, measurement, endpoint, organization, created, status, kernelName, kernelRelease, kernelVersion, processor, nodeName, lsbDistributor, lsbRelease, lsbCodename, graphNodes, graphEdges, errorCode, errorPhase]. When the value starts with -, results will be sorted in descending order, + returns results sorted in ascending order.
offset
String

Offset key from the previous page of results

Responses

Status: 200 - Successful operation

{

Represents a page of list appraisals results

data:
[
{

An appraisal of an endpoint

id:
string (invaryId)

Id of the appraisal

Example: yfbq34r59aq1a83usemkvzmtk
measurement:
string (invaryId)

Id of the endpoint measurement that was appraised

Example: gv3pnqqge17hd2ahdr3k484qv
endpoint:
string (invaryId)

Id of the endpoint that that was measured and appraised

Example: dqcam653hsdrd2g31qnsqy6ak
organization:
string (invaryId)

Id of the organization that owns the appraisal

Example: 8z2xfqppx4xfa0fnm40ee063d
created:
string (date-time)

Date and time of the appraisal

Example: 2023-07-11T15:45:23.851517Z
status:
string

Status of the appraisal

Example: SUCCESSFUL
Enum: UNKNOWN, SUCCESSFUL, FAILED, ERRORED
passed:
[

The set of appraisal areas that passed

string

A passing appraisal area

]
failed:
[

The set of appraisal areas that failed

string

A failing appraisal area

]
graphNodes:
integer

Number of kernel graph nodes in the measurement

Example: 101623
graphEdges:
integer

Number of kernel graph edges in the measurement

Example: 355197
tags:
[

The set of tags applied to the endpoint

string

A tag that has been applied to the endpoint

]
kernelName:
string

Name of the operating system kernel on the endpoint during appraisal

Example: Linux
kernelRelease:
string

Operating system kernel release on the endpoint during appraisal

Example: 5.15.0-67-generic
kernelVersion:
string

Operating system kernel version on the endpoint during appraisal

Example: #74~20.04.1-Ubuntu SMP Wed Feb 22 14:52:34 UTC 2023
processor:
string

Endpoint processor family during appraisal

Example: x86_64
nodeName:
string

Endpoint hostname during appraisal

Example: hostname
lsbDistributor:
string

Operating system distribution during appraisal

Example: Ubuntu
lsbRelease:
string

Operating system distribution release during appraisal

Example: 20.04
lsbCodename:
string

Operating system distribution release code name during appraisal

Example: focal
lsbDescription:
string

Description of the operating system release during appraisal

Example: Ubuntu 20.04.6 LTS
]
offset:
string
Example: Zj56sPIvviD5IhmxSKqRyqBLABfbulymL949082oarhAo3gPynjwJjBhBiQqtOcFdIcsAt7H9yfUMQTYWX8=

Endpoint

deprovisionEndpoint

Deprovision Endpoint

Changes the state of an endpoint to DEPROVISIONED so it will no longer be appraised


/org/{orgId}/endpoint/{endpointId}/deprovision

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://api.invary.com/api/org/{orgId}/endpoint/{endpointId}/deprovision"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointApi;

import java.io.File;
import java.util.*;

public class EndpointApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearer_token
        HttpBearerAuth bearer_token = (HttpBearerAuth) defaultClient.getAuthentication("bearer_token");
        bearer_token.setBearerToken("BEARER TOKEN");
        
        // Create an instance of the API class
        EndpointApi apiInstance = new EndpointApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to deprovision
        Object body = Object; // Object | 
        
        try {
            Endpoint result = apiInstance.deprovisionEndpoint(orgId, endpointId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#deprovisionEndpoint");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointApi;

public class EndpointApiExample {
    public static void main(String[] args) {
        EndpointApi apiInstance = new EndpointApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to deprovision
        Object body = Object; // Object | 
        
        try {
            Endpoint result = apiInstance.deprovisionEndpoint(orgId, endpointId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#deprovisionEndpoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearer_token
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointApi *apiInstance = [[EndpointApi alloc] init];
String *orgId = 6ph6yrsfsavua4wu57zff5hb3; // Id of the owning organization (default to null)
String *endpointId = ust1639fct23cwmg2xug5x78v; // Id of the endpoint to deprovision (default to null)
Object *body = Object; // 

// Deprovision Endpoint
[apiInstance deprovisionEndpointWith:orgId
    endpointId:endpointId
    body:body
              completionHandler: ^(Endpoint output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var InvaryRuntimeIntegrity = require('invary_runtime_integrity');
var defaultClient = InvaryRuntimeIntegrity.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearer_token
var bearer_token = defaultClient.authentications['bearer_token'];
bearer_token.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new InvaryRuntimeIntegrity.EndpointApi()
var orgId = 6ph6yrsfsavua4wu57zff5hb3; // {String} Id of the owning organization
var endpointId = ust1639fct23cwmg2xug5x78v; // {String} Id of the endpoint to deprovision
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deprovisionEndpoint(orgId, endpointId, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deprovisionEndpointExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearer_token
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new EndpointApi();
            var orgId = 6ph6yrsfsavua4wu57zff5hb3;  // String | Id of the owning organization (default to null)
            var endpointId = ust1639fct23cwmg2xug5x78v;  // String | Id of the endpoint to deprovision (default to null)
            var body = Object;  // Object | 

            try {
                // Deprovision Endpoint
                Endpoint result = apiInstance.deprovisionEndpoint(orgId, endpointId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointApi.deprovisionEndpoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearer_token
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointApi();
$orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
$endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to deprovision
$body = Object; // Object | 

try {
    $result = $api_instance->deprovisionEndpoint($orgId, $endpointId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointApi->deprovisionEndpoint: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointApi;

# Configure Bearer (JWT) access token for authorization: bearer_token
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointApi->new();
my $orgId = 6ph6yrsfsavua4wu57zff5hb3; # String | Id of the owning organization
my $endpointId = ust1639fct23cwmg2xug5x78v; # String | Id of the endpoint to deprovision
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval { 
    my $result = $api_instance->deprovisionEndpoint(orgId => $orgId, endpointId => $endpointId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointApi->deprovisionEndpoint: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearer_token
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EndpointApi()
orgId = 6ph6yrsfsavua4wu57zff5hb3 # String | Id of the owning organization (default to null)
endpointId = ust1639fct23cwmg2xug5x78v # String | Id of the endpoint to deprovision (default to null)
body = Object # Object | 

try: 
    # Deprovision Endpoint
    api_response = api_instance.deprovision_endpoint(orgId, endpointId, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointApi->deprovisionEndpoint: %s\n" % e)
extern crate EndpointApi;

pub fn main() {
    let orgId = 6ph6yrsfsavua4wu57zff5hb3; // String
    let endpointId = ust1639fct23cwmg2xug5x78v; // String
    let body = Object; // Object

    let mut context = EndpointApi::Context::default();
    let result = client.deprovisionEndpoint(orgId, endpointId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
orgId*
String (invaryId)

Id of the owning organization

Required
endpointId*
String (invaryId)

Id of the endpoint to deprovision

Required
Body parameters
Name Description
body *

Empty object request body

Responses

Status: 200 - Successful operation

{

An endpoint for which appraisals are generated

id:
string (invaryId)

Id of the endpoint object

Example: mh02ckw0e10kczu7adkz0r5yp
organization:
string (invaryId)

Id of the organization that owns the endpoint

Example: 8z2xfqppx4xfa0fnm40ee063d
provisioningToken:
string (invaryId)

Provisioning token used to provision the endpoint

Example: pqdwsnzsu437a51h05419p63v
created:
string (date-time)

Date and time when the endpoint was first provisioned

Example: 2023-07-05T21:47:55.264395Z
modified:
string (date-time)

Date and time when the endpoint was last modified

Example: 2023-07-05T21:47:55.264395Z
state:
string

Current state of the endpoint

Example: ACTIVE
Enum: UNKNOWN, PROVISIONED, ACTIVE, DEPROVISIONED, DELETED
stateChangedAt:
string (date-time)

Date and time when the endpoint state was last changed

Example: 2023-07-05T21:47:55.264395Z
tags:
[
string

A tag that has been applied to this endpoint

]
machineId:
string
lastConnect:
string (date-time)

Date and time when this endpoint last initiated a connection with the platform

Example: 2023-07-05T21:47:55.264395Z
lastSeen:
string (date-time)

Date and time when this endpoint last sent a check-in status to the platform

Example: 2023-07-05T21:47:55.264395Z
lastMeasurement:
string (date-time)

Date and time when this endpoint last posted a measurement

Example: 2023-07-05T21:47:55.264395Z
lastAppraisal:
string (date-time)

Date and time of the last appraisal for this endpoint

Example: 2023-07-05T21:47:55.264395Z
lastAppraisalResult:
string

Result of the last appraisal for this endpoint

Example: SUCCESSFUL
Enum: APPRAISAL_STATUS_UNKNOWN, SUCCESSFUL, FAILED, ERRORED
Example: 
{
    "id": "ust1639fct23cwmg2xug5x78v",
    "organization": "6ph6yrsfsavua4wu57zff5hb3",
    "provisioningToken": "9c1zz6n88mebdppfxwbgae24x",
    "created": "2023-07-10T17:01:41.872605Z",
    "modified": "2023-07-10T17:01:42.099456Z",
    "state": "ACTIVE",
    "stateChangedAt": "2023-07-10T17:02:44.007548Z",
    "tags": [
        "tag1",
        "tag2"
    ],
    "machineId": [],
    "lastConnect": "2023-07-10T17:01:42.099456Z",
    "lastSeen": "2023-07-11T12:43:31.982721Z",
    "lastMeasurement": "2023-07-11T12:43:01.547930Z",
    "lastAppraisal": "2023-07-11T12:43:04.118361Z",
    "lastAppraisalResult": "FAILED"
}

getEndpoint

Get Endpoint

Retrieves an endpoint by id


/org/{orgId}/endpoint/{endpointId}

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
 -H "Accept: application/json"\
 "https://api.invary.com/api/org/{orgId}/endpoint/{endpointId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointApi;

import java.io.File;
import java.util.*;

public class EndpointApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearer_token
        HttpBearerAuth bearer_token = (HttpBearerAuth) defaultClient.getAuthentication("bearer_token");
        bearer_token.setBearerToken("BEARER TOKEN");
        
        // Create an instance of the API class
        EndpointApi apiInstance = new EndpointApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to retrieve
        
        try {
            EndpointList result = apiInstance.getEndpoint(orgId, endpointId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#getEndpoint");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointApi;

public class EndpointApiExample {
    public static void main(String[] args) {
        EndpointApi apiInstance = new EndpointApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to retrieve
        
        try {
            EndpointList result = apiInstance.getEndpoint(orgId, endpointId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#getEndpoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearer_token
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointApi *apiInstance = [[EndpointApi alloc] init];
String *orgId = 6ph6yrsfsavua4wu57zff5hb3; // Id of the owning organization (default to null)
String *endpointId = ust1639fct23cwmg2xug5x78v; // Id of the endpoint to retrieve (default to null)

// Get Endpoint
[apiInstance getEndpointWith:orgId
    endpointId:endpointId
              completionHandler: ^(EndpointList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var InvaryRuntimeIntegrity = require('invary_runtime_integrity');
var defaultClient = InvaryRuntimeIntegrity.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearer_token
var bearer_token = defaultClient.authentications['bearer_token'];
bearer_token.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new InvaryRuntimeIntegrity.EndpointApi()
var orgId = 6ph6yrsfsavua4wu57zff5hb3; // {String} Id of the owning organization
var endpointId = ust1639fct23cwmg2xug5x78v; // {String} Id of the endpoint to retrieve

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getEndpoint(orgId, endpointId, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getEndpointExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearer_token
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new EndpointApi();
            var orgId = 6ph6yrsfsavua4wu57zff5hb3;  // String | Id of the owning organization (default to null)
            var endpointId = ust1639fct23cwmg2xug5x78v;  // String | Id of the endpoint to retrieve (default to null)

            try {
                // Get Endpoint
                EndpointList result = apiInstance.getEndpoint(orgId, endpointId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointApi.getEndpoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearer_token
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointApi();
$orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
$endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to retrieve

try {
    $result = $api_instance->getEndpoint($orgId, $endpointId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointApi->getEndpoint: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointApi;

# Configure Bearer (JWT) access token for authorization: bearer_token
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointApi->new();
my $orgId = 6ph6yrsfsavua4wu57zff5hb3; # String | Id of the owning organization
my $endpointId = ust1639fct23cwmg2xug5x78v; # String | Id of the endpoint to retrieve

eval { 
    my $result = $api_instance->getEndpoint(orgId => $orgId, endpointId => $endpointId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointApi->getEndpoint: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearer_token
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EndpointApi()
orgId = 6ph6yrsfsavua4wu57zff5hb3 # String | Id of the owning organization (default to null)
endpointId = ust1639fct23cwmg2xug5x78v # String | Id of the endpoint to retrieve (default to null)

try: 
    # Get Endpoint
    api_response = api_instance.get_endpoint(orgId, endpointId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointApi->getEndpoint: %s\n" % e)
extern crate EndpointApi;

pub fn main() {
    let orgId = 6ph6yrsfsavua4wu57zff5hb3; // String
    let endpointId = ust1639fct23cwmg2xug5x78v; // String

    let mut context = EndpointApi::Context::default();
    let result = client.getEndpoint(orgId, endpointId, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
orgId*
String (invaryId)

Id of the owning organization

Required
endpointId*
String (invaryId)

Id of the endpoint to retrieve

Required

Responses

Status: 200 - Successful operation

{

Represents a page of list endpoints results

data:
[
{

An endpoint with optional additional metadata

endpoint:
{

An endpoint for which appraisals are generated

id:
string (invaryId)

Id of the endpoint object

Example: mh02ckw0e10kczu7adkz0r5yp
organization:
string (invaryId)

Id of the organization that owns the endpoint

Example: 8z2xfqppx4xfa0fnm40ee063d
provisioningToken:
string (invaryId)

Provisioning token used to provision the endpoint

Example: pqdwsnzsu437a51h05419p63v
created:
string (date-time)

Date and time when the endpoint was first provisioned

Example: 2023-07-05T21:47:55.264395Z
modified:
string (date-time)

Date and time when the endpoint was last modified

Example: 2023-07-05T21:47:55.264395Z
state:
string

Current state of the endpoint

Example: ACTIVE
Enum: UNKNOWN, PROVISIONED, ACTIVE, DEPROVISIONED, DELETED
stateChangedAt:
string (date-time)

Date and time when the endpoint state was last changed

Example: 2023-07-05T21:47:55.264395Z
tags:
[
string

A tag that has been applied to this endpoint

]
machineId:
string
lastConnect:
string (date-time)

Date and time when this endpoint last initiated a connection with the platform

Example: 2023-07-05T21:47:55.264395Z
lastSeen:
string (date-time)

Date and time when this endpoint last sent a check-in status to the platform

Example: 2023-07-05T21:47:55.264395Z
lastMeasurement:
string (date-time)

Date and time when this endpoint last posted a measurement

Example: 2023-07-05T21:47:55.264395Z
lastAppraisal:
string (date-time)

Date and time of the last appraisal for this endpoint

Example: 2023-07-05T21:47:55.264395Z
lastAppraisalResult:
string

Result of the last appraisal for this endpoint

Example: SUCCESSFUL
Enum: APPRAISAL_STATUS_UNKNOWN, SUCCESSFUL, FAILED, ERRORED
Example: 
{
    "id": "ust1639fct23cwmg2xug5x78v",
    "organization": "6ph6yrsfsavua4wu57zff5hb3",
    "provisioningToken": "9c1zz6n88mebdppfxwbgae24x",
    "created": "2023-07-10T17:01:41.872605Z",
    "modified": "2023-07-10T17:01:42.099456Z",
    "state": "ACTIVE",
    "stateChangedAt": "2023-07-10T17:02:44.007548Z",
    "tags": [
        "tag1",
        "tag2"
    ],
    "machineId": [],
    "lastConnect": "2023-07-10T17:01:42.099456Z",
    "lastSeen": "2023-07-11T12:43:31.982721Z",
    "lastMeasurement": "2023-07-11T12:43:01.547930Z",
    "lastAppraisal": "2023-07-11T12:43:04.118361Z",
    "lastAppraisalResult": "FAILED"
}
osInfo:
{

Additional metadata about the operating system running on an endpoint

id:
string (invaryId)

Id of this os info object

Example: trvfkzszh9wsc81crb13y9cew
endpointId:
string (invaryId)

Id of the endpoint that this os info applies to

Example: mh02ckw0e10kczu7adkz0r5yp
created:
string (date-time)

Date and time when this os info object was created

Example: 2023-07-05T21:47:55.544388Z
kernelName:
string

Name of the os kernel

Example: Linux
kernelRelease:
string

Release of the os kernel

Example: 5.15.0-71-generic
kernelVersion:
string

Version of the os kernel

Example: #78~20.04.1-Ubuntu SMP Wed Apr 19 11:26:48 UTC 2023
processor:
string

Endpoint processor family

Example: x86_64
nodeName:
string

Endpoint node or host name

Example: server1
lsbDistributor:
string

Distribution name

Example: Ubuntu
lsbRelease:
string

Distribution release

Example: 20.04
lsbCodename:
string

Distribution release codename

Example: focal
Example: 
{
    "id": "trvfkzszh9wsc81crb13y9cew",
    "endpointId": "mh02ckw0e10kczu7adkz0r5yp",
    "created": "2023-07-05T21:47:55.544388Z",
    "kernelName": "Linux",
    "kernelRelease": "5.15.0-71-generic",
    "kernelVersion": "#78~20.04.1-Ubuntu SMP Wed Apr 19 11:26:48 UTC 2023",
    "processor": "x86_64",
    "nodeName": "nucit",
    "lsbDistributor": "Ubuntu",
    "lsbRelease": "20.04",
    "lsbCodename": "focal"
}
routeTable:
[

Reserved for future use

string
]
]
offset:
string
Example: hSYxP49qy3wKvTsbcjHQ7h50RpUHYwBzv_oy9xrLTCwWEptMI8Z70azCWCZ_ezOFTmTaS6L60tFeZcT6Yeh6QevzdRquOB4JgIqIjFpPE_uBIiQJI4KRQOnlN7yEEKc=

listEndpoints

List Endpoints

Lists the endpoints that have been provisioned under the given organization. For each call, at most page_size results are returned. If there are additional pages of results, the offset field will be returned containing a key that can be provided in a new request to fetch the next page. When the optional os parameter is returned, results will also include information about the operating system installed on the endpoint. Results can be sorted with the optional sort parameter.


/org/{orgId}/endpoint

Usage and SDK Samples

curl -X GET\
 -H "Authorization: Bearer [[accessToken]]"\
 -H "Accept: application/json"\
 "https://api.invary.com/api/org/{orgId}/endpoint?page_size=&sort=&os=&offset="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointApi;

import java.io.File;
import java.util.*;

public class EndpointApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearer_token
        HttpBearerAuth bearer_token = (HttpBearerAuth) defaultClient.getAuthentication("bearer_token");
        bearer_token.setBearerToken("BEARER TOKEN");
        
        // Create an instance of the API class
        EndpointApi apiInstance = new EndpointApi();
        String orgId = orgId_example; // String | Id of the owning organization
        Integer pageSize = 56; // Integer | Maximum number of endpoints to return per page
        String sort = -lastAppraisal; // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
        Boolean os = true; // Boolean | Return OSInfo for endpoints in the response
        String offset = offset_example; // String | Offset key from the previous page of results
        
        try {
            EndpointList result = apiInstance.listEndpoints(orgId, pageSize, sort, os, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#listEndpoints");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointApi;

public class EndpointApiExample {
    public static void main(String[] args) {
        EndpointApi apiInstance = new EndpointApi();
        String orgId = orgId_example; // String | Id of the owning organization
        Integer pageSize = 56; // Integer | Maximum number of endpoints to return per page
        String sort = -lastAppraisal; // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
        Boolean os = true; // Boolean | Return OSInfo for endpoints in the response
        String offset = offset_example; // String | Offset key from the previous page of results
        
        try {
            EndpointList result = apiInstance.listEndpoints(orgId, pageSize, sort, os, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#listEndpoints");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearer_token
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointApi *apiInstance = [[EndpointApi alloc] init];
String *orgId = orgId_example; // Id of the owning organization (default to null)
Integer *pageSize = 56; // Maximum number of endpoints to return per page (optional) (default to 25)
String *sort = -lastAppraisal; // Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order. (optional) (default to -created)
Boolean *os = true; // Return OSInfo for endpoints in the response (optional) (default to false)
String *offset = offset_example; // Offset key from the previous page of results (optional) (default to null)

// List Endpoints
[apiInstance listEndpointsWith:orgId
    pageSize:pageSize
    sort:sort
    os:os
    offset:offset
              completionHandler: ^(EndpointList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var InvaryRuntimeIntegrity = require('invary_runtime_integrity');
var defaultClient = InvaryRuntimeIntegrity.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearer_token
var bearer_token = defaultClient.authentications['bearer_token'];
bearer_token.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new InvaryRuntimeIntegrity.EndpointApi()
var orgId = orgId_example; // {String} Id of the owning organization
var opts = {
  'pageSize': 56, // {Integer} Maximum number of endpoints to return per page
  'sort': -lastAppraisal, // {String} Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
  'os': true, // {Boolean} Return OSInfo for endpoints in the response
  'offset': offset_example // {String} Offset key from the previous page of results
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.listEndpoints(orgId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class listEndpointsExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearer_token
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new EndpointApi();
            var orgId = orgId_example;  // String | Id of the owning organization (default to null)
            var pageSize = 56;  // Integer | Maximum number of endpoints to return per page (optional)  (default to 25)
            var sort = -lastAppraisal;  // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order. (optional)  (default to -created)
            var os = true;  // Boolean | Return OSInfo for endpoints in the response (optional)  (default to false)
            var offset = offset_example;  // String | Offset key from the previous page of results (optional)  (default to null)

            try {
                // List Endpoints
                EndpointList result = apiInstance.listEndpoints(orgId, pageSize, sort, os, offset);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointApi.listEndpoints: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearer_token
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointApi();
$orgId = orgId_example; // String | Id of the owning organization
$pageSize = 56; // Integer | Maximum number of endpoints to return per page
$sort = -lastAppraisal; // String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
$os = true; // Boolean | Return OSInfo for endpoints in the response
$offset = offset_example; // String | Offset key from the previous page of results

try {
    $result = $api_instance->listEndpoints($orgId, $pageSize, $sort, $os, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointApi->listEndpoints: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointApi;

# Configure Bearer (JWT) access token for authorization: bearer_token
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointApi->new();
my $orgId = orgId_example; # String | Id of the owning organization
my $pageSize = 56; # Integer | Maximum number of endpoints to return per page
my $sort = -lastAppraisal; # String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order.
my $os = true; # Boolean | Return OSInfo for endpoints in the response
my $offset = offset_example; # String | Offset key from the previous page of results

eval { 
    my $result = $api_instance->listEndpoints(orgId => $orgId, pageSize => $pageSize, sort => $sort, os => $os, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointApi->listEndpoints: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearer_token
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EndpointApi()
orgId = orgId_example # String | Id of the owning organization (default to null)
pageSize = 56 # Integer | Maximum number of endpoints to return per page (optional) (default to 25)
sort = -lastAppraisal # String | Sort order to be applied to results.  The value is in the form of `+/-` + `field` where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken].  When the value starts with `-`, results will be sorted in descending order, `+` returns results sorted in ascending order. (optional) (default to -created)
os = true # Boolean | Return OSInfo for endpoints in the response (optional) (default to false)
offset = offset_example # String | Offset key from the previous page of results (optional) (default to null)

try: 
    # List Endpoints
    api_response = api_instance.list_endpoints(orgId, pageSize=pageSize, sort=sort, os=os, offset=offset)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointApi->listEndpoints: %s\n" % e)
extern crate EndpointApi;

pub fn main() {
    let orgId = orgId_example; // String
    let pageSize = 56; // Integer
    let sort = -lastAppraisal; // String
    let os = true; // Boolean
    let offset = offset_example; // String

    let mut context = EndpointApi::Context::default();
    let result = client.listEndpoints(orgId, pageSize, sort, os, offset, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
orgId*
String (invaryId)

Id of the owning organization

Required
Query parameters
Name Description
page_size
Integer

Maximum number of endpoints to return per page
sort
String

Sort order to be applied to results. The value is in the form of +/- + field where field is one of [id, created, modified, organization, state, stateChangedAt, lastConnect, lastSeen, lastMeasurement, lastAppraisal, lastAppraisalResult, provisioningToken]. When the value starts with -, results will be sorted in descending order, + returns results sorted in ascending order.
os
Boolean

Return OSInfo for endpoints in the response
offset
String

Offset key from the previous page of results

Responses

Status: 200 - Successful operation

{

Represents a page of list endpoints results

data:
[
{

An endpoint with optional additional metadata

endpoint:
{

An endpoint for which appraisals are generated

id:
string (invaryId)

Id of the endpoint object

Example: mh02ckw0e10kczu7adkz0r5yp
organization:
string (invaryId)

Id of the organization that owns the endpoint

Example: 8z2xfqppx4xfa0fnm40ee063d
provisioningToken:
string (invaryId)

Provisioning token used to provision the endpoint

Example: pqdwsnzsu437a51h05419p63v
created:
string (date-time)

Date and time when the endpoint was first provisioned

Example: 2023-07-05T21:47:55.264395Z
modified:
string (date-time)

Date and time when the endpoint was last modified

Example: 2023-07-05T21:47:55.264395Z
state:
string

Current state of the endpoint

Example: ACTIVE
Enum: UNKNOWN, PROVISIONED, ACTIVE, DEPROVISIONED, DELETED
stateChangedAt:
string (date-time)

Date and time when the endpoint state was last changed

Example: 2023-07-05T21:47:55.264395Z
tags:
[
string

A tag that has been applied to this endpoint

]
machineId:
string
lastConnect:
string (date-time)

Date and time when this endpoint last initiated a connection with the platform

Example: 2023-07-05T21:47:55.264395Z
lastSeen:
string (date-time)

Date and time when this endpoint last sent a check-in status to the platform

Example: 2023-07-05T21:47:55.264395Z
lastMeasurement:
string (date-time)

Date and time when this endpoint last posted a measurement

Example: 2023-07-05T21:47:55.264395Z
lastAppraisal:
string (date-time)

Date and time of the last appraisal for this endpoint

Example: 2023-07-05T21:47:55.264395Z
lastAppraisalResult:
string

Result of the last appraisal for this endpoint

Example: SUCCESSFUL
Enum: APPRAISAL_STATUS_UNKNOWN, SUCCESSFUL, FAILED, ERRORED
Example: 
{
    "id": "ust1639fct23cwmg2xug5x78v",
    "organization": "6ph6yrsfsavua4wu57zff5hb3",
    "provisioningToken": "9c1zz6n88mebdppfxwbgae24x",
    "created": "2023-07-10T17:01:41.872605Z",
    "modified": "2023-07-10T17:01:42.099456Z",
    "state": "ACTIVE",
    "stateChangedAt": "2023-07-10T17:02:44.007548Z",
    "tags": [
        "tag1",
        "tag2"
    ],
    "machineId": [],
    "lastConnect": "2023-07-10T17:01:42.099456Z",
    "lastSeen": "2023-07-11T12:43:31.982721Z",
    "lastMeasurement": "2023-07-11T12:43:01.547930Z",
    "lastAppraisal": "2023-07-11T12:43:04.118361Z",
    "lastAppraisalResult": "FAILED"
}
osInfo:
{

Additional metadata about the operating system running on an endpoint

id:
string (invaryId)

Id of this os info object

Example: trvfkzszh9wsc81crb13y9cew
endpointId:
string (invaryId)

Id of the endpoint that this os info applies to

Example: mh02ckw0e10kczu7adkz0r5yp
created:
string (date-time)

Date and time when this os info object was created

Example: 2023-07-05T21:47:55.544388Z
kernelName:
string

Name of the os kernel

Example: Linux
kernelRelease:
string

Release of the os kernel

Example: 5.15.0-71-generic
kernelVersion:
string

Version of the os kernel

Example: #78~20.04.1-Ubuntu SMP Wed Apr 19 11:26:48 UTC 2023
processor:
string

Endpoint processor family

Example: x86_64
nodeName:
string

Endpoint node or host name

Example: server1
lsbDistributor:
string

Distribution name

Example: Ubuntu
lsbRelease:
string

Distribution release

Example: 20.04
lsbCodename:
string

Distribution release codename

Example: focal
Example: 
{
    "id": "trvfkzszh9wsc81crb13y9cew",
    "endpointId": "mh02ckw0e10kczu7adkz0r5yp",
    "created": "2023-07-05T21:47:55.544388Z",
    "kernelName": "Linux",
    "kernelRelease": "5.15.0-71-generic",
    "kernelVersion": "#78~20.04.1-Ubuntu SMP Wed Apr 19 11:26:48 UTC 2023",
    "processor": "x86_64",
    "nodeName": "nucit",
    "lsbDistributor": "Ubuntu",
    "lsbRelease": "20.04",
    "lsbCodename": "focal"
}
routeTable:
[

Reserved for future use

string
]
]
offset:
string
Example: hSYxP49qy3wKvTsbcjHQ7h50RpUHYwBzv_oy9xrLTCwWEptMI8Z70azCWCZ_ezOFTmTaS6L60tFeZcT6Yeh6QevzdRquOB4JgIqIjFpPE_uBIiQJI4KRQOnlN7yEEKc=

reactivateEndpoint

Reactivate Endpoint

Changes the state of an deprovisioned endpoint from DEPROVISIONED to ACTIVE so it will once again be appraised


/org/{orgId}/endpoint/{endpointId}/reactivate

Usage and SDK Samples

curl -X POST\
 -H "Authorization: Bearer [[accessToken]]"\
 -H "Accept: application/json"\
 -H "Content-Type: application/json"\
 "https://api.invary.com/api/org/{orgId}/endpoint/{endpointId}/reactivate"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.EndpointApi;

import java.io.File;
import java.util.*;

public class EndpointApiExample {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure Bearer (JWT) access token for authorization: bearer_token
        HttpBearerAuth bearer_token = (HttpBearerAuth) defaultClient.getAuthentication("bearer_token");
        bearer_token.setBearerToken("BEARER TOKEN");
        
        // Create an instance of the API class
        EndpointApi apiInstance = new EndpointApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to reactivate
        Object body = Object; // Object | 
        
        try {
            Endpoint result = apiInstance.reactivateEndpoint(orgId, endpointId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#reactivateEndpoint");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.EndpointApi;

public class EndpointApiExample {
    public static void main(String[] args) {
        EndpointApi apiInstance = new EndpointApi();
        String orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
        String endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to reactivate
        Object body = Object; // Object | 
        
        try {
            Endpoint result = apiInstance.reactivateEndpoint(orgId, endpointId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EndpointApi#reactivateEndpoint");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure Bearer (JWT) access token for authorization: bearer_token
[apiConfig setAccessToken:@"YOUR_ACCESS_TOKEN"];

// Create an instance of the API class
EndpointApi *apiInstance = [[EndpointApi alloc] init];
String *orgId = 6ph6yrsfsavua4wu57zff5hb3; // Id of the owning organization (default to null)
String *endpointId = ust1639fct23cwmg2xug5x78v; // Id of the endpoint to reactivate (default to null)
Object *body = Object; // 

// Reactivate Endpoint
[apiInstance reactivateEndpointWith:orgId
    endpointId:endpointId
    body:body
              completionHandler: ^(Endpoint output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var InvaryRuntimeIntegrity = require('invary_runtime_integrity');
var defaultClient = InvaryRuntimeIntegrity.ApiClient.instance;

// Configure Bearer (JWT) access token for authorization: bearer_token
var bearer_token = defaultClient.authentications['bearer_token'];
bearer_token.accessToken = "YOUR ACCESS TOKEN";

// Create an instance of the API class
var api = new InvaryRuntimeIntegrity.EndpointApi()
var orgId = 6ph6yrsfsavua4wu57zff5hb3; // {String} Id of the owning organization
var endpointId = ust1639fct23cwmg2xug5x78v; // {String} Id of the endpoint to reactivate
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.reactivateEndpoint(orgId, endpointId, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class reactivateEndpointExample
    {
        public void main()
        {
            // Configure Bearer (JWT) access token for authorization: bearer_token
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";
            
            // Create an instance of the API class
            var apiInstance = new EndpointApi();
            var orgId = 6ph6yrsfsavua4wu57zff5hb3;  // String | Id of the owning organization (default to null)
            var endpointId = ust1639fct23cwmg2xug5x78v;  // String | Id of the endpoint to reactivate (default to null)
            var body = Object;  // Object | 

            try {
                // Reactivate Endpoint
                Endpoint result = apiInstance.reactivateEndpoint(orgId, endpointId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling EndpointApi.reactivateEndpoint: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure Bearer (JWT) access token for authorization: bearer_token
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setAccessToken('', 'YOUR_ACCESS_TOKEN');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\EndpointApi();
$orgId = 6ph6yrsfsavua4wu57zff5hb3; // String | Id of the owning organization
$endpointId = ust1639fct23cwmg2xug5x78v; // String | Id of the endpoint to reactivate
$body = Object; // Object | 

try {
    $result = $api_instance->reactivateEndpoint($orgId, $endpointId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointApi->reactivateEndpoint: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::EndpointApi;

# Configure Bearer (JWT) access token for authorization: bearer_token
$WWW::OPenAPIClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::EndpointApi->new();
my $orgId = 6ph6yrsfsavua4wu57zff5hb3; # String | Id of the owning organization
my $endpointId = ust1639fct23cwmg2xug5x78v; # String | Id of the endpoint to reactivate
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval { 
    my $result = $api_instance->reactivateEndpoint(orgId => $orgId, endpointId => $endpointId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EndpointApi->reactivateEndpoint: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Configure Bearer (JWT) access token for authorization: bearer_token
openapi_client.configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Create an instance of the API class
api_instance = openapi_client.EndpointApi()
orgId = 6ph6yrsfsavua4wu57zff5hb3 # String | Id of the owning organization (default to null)
endpointId = ust1639fct23cwmg2xug5x78v # String | Id of the endpoint to reactivate (default to null)
body = Object # Object | 

try: 
    # Reactivate Endpoint
    api_response = api_instance.reactivate_endpoint(orgId, endpointId, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EndpointApi->reactivateEndpoint: %s\n" % e)
extern crate EndpointApi;

pub fn main() {
    let orgId = 6ph6yrsfsavua4wu57zff5hb3; // String
    let endpointId = ust1639fct23cwmg2xug5x78v; // String
    let body = Object; // Object

    let mut context = EndpointApi::Context::default();
    let result = client.reactivateEndpoint(orgId, endpointId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
orgId*
String (invaryId)

Id of the owning organization

Required
endpointId*
String (invaryId)

Id of the endpoint to reactivate

Required
Body parameters
Name Description
body *

Empty object request body

Responses

Status: 200 - Successful operation

{

An endpoint for which appraisals are generated

id:
string (invaryId)

Id of the endpoint object

Example: mh02ckw0e10kczu7adkz0r5yp
organization:
string (invaryId)

Id of the organization that owns the endpoint

Example: 8z2xfqppx4xfa0fnm40ee063d
provisioningToken:
string (invaryId)

Provisioning token used to provision the endpoint

Example: pqdwsnzsu437a51h05419p63v
created:
string (date-time)

Date and time when the endpoint was first provisioned

Example: 2023-07-05T21:47:55.264395Z
modified:
string (date-time)

Date and time when the endpoint was last modified

Example: 2023-07-05T21:47:55.264395Z
state:
string

Current state of the endpoint

Example: ACTIVE
Enum: UNKNOWN, PROVISIONED, ACTIVE, DEPROVISIONED, DELETED
stateChangedAt:
string (date-time)

Date and time when the endpoint state was last changed

Example: 2023-07-05T21:47:55.264395Z
tags:
[
string

A tag that has been applied to this endpoint

]
machineId:
string
lastConnect:
string (date-time)

Date and time when this endpoint last initiated a connection with the platform

Example: 2023-07-05T21:47:55.264395Z
lastSeen:
string (date-time)

Date and time when this endpoint last sent a check-in status to the platform

Example: 2023-07-05T21:47:55.264395Z
lastMeasurement:
string (date-time)

Date and time when this endpoint last posted a measurement

Example: 2023-07-05T21:47:55.264395Z
lastAppraisal:
string (date-time)

Date and time of the last appraisal for this endpoint

Example: 2023-07-05T21:47:55.264395Z
lastAppraisalResult:
string

Result of the last appraisal for this endpoint

Example: SUCCESSFUL
Enum: APPRAISAL_STATUS_UNKNOWN, SUCCESSFUL, FAILED, ERRORED
Example: 
{
    "id": "ust1639fct23cwmg2xug5x78v",
    "organization": "6ph6yrsfsavua4wu57zff5hb3",
    "provisioningToken": "9c1zz6n88mebdppfxwbgae24x",
    "created": "2023-07-10T17:01:41.872605Z",
    "modified": "2023-07-10T17:01:42.099456Z",
    "state": "ACTIVE",
    "stateChangedAt": "2023-07-10T17:02:44.007548Z",
    "tags": [
        "tag1",
        "tag2"
    ],
    "machineId": [],
    "lastConnect": "2023-07-10T17:01:42.099456Z",
    "lastSeen": "2023-07-11T12:43:31.982721Z",
    "lastMeasurement": "2023-07-11T12:43:01.547930Z",
    "lastAppraisal": "2023-07-11T12:43:04.118361Z",
    "lastAppraisalResult": "FAILED"
}