Getting Started

Processes (v2)

Processes (v1) - DEPRECATED

Triggers

Console

API

Plugins (v2)

Plugins (v1) - DEPRECATED

Templates

CLI

Community

Edit this page on GitHub

Home > docs > api > Node Roster

Node Roster

Node Roster provides access to data gathered during Ansible playbook executions.

Hosts

List Hosts With An Artifact

Returns a paginated list of all hosts that had the specified artifact deployed on.

  • URI /api/v1/noderoster/hosts?artifact=${artifactPattern}&offset=${offset}&limit=${limit}
  • Query parameters
    • artifact: regex, the artifact’s URL pattern;
    • limit: maximum number of records to return;
    • offset: starting index from which to return.
  • Method GET
  • Headers Authorization
  • Body none

  • Success response

      Content-Type: application/json
    Copy
      [ {
    "id" : "d18f60ec-4804-11ea-9e99-0242ac110003",
    "name" : "hostb",
    "createdAt" : "2020-02-05T10:46:52.112Z",
    "artifactUrl" : "http://localhost:57675/test.txt"
  }, {
    "id" : "d18eeb8a-4804-11ea-9e99-0242ac110003",
    "name" : "hosta",
    "createdAt" : "2020-02-05T10:46:52.109Z",
    "artifactUrl" : "http://localhost:57675/test.txt"
  } ]
    Copy

    The result is a list of hosts where are artifact URLs matching the supplied artifactPattern

Processes Which Deployed to a Host

Returns a (paginated) list of processes that touched the specified host.

  • URI /api/v1/noderoster/processes?hostName=${hostName}&hostId=${hostId}&offset=${offset}&limit=${limit}
  • Query parameters
    • hostName: name of the host;
    • hostId: ID of the host;
    • limit: maximum number of records to return;
    • offset: starting index from which to return.

    Either hostName or hostId must be specified.

  • Method GET
  • Headers Authorization
  • Body none

  • Success response

      Content-Type: application/json
    Copy
      [ {
    "instanceId" : "5285f431-3551-4467-ad31-b43e9693eaab",
    "createdAt" : "2020-02-03T20:32:07.276Z",
    "initiatorId" : "230c5c9c-d9a7-11e6-bcfd-bb681c07b26c",
    "initiator" : "admin"
  } ]
    Copy

Facts

Latest Host Facts

Returns the latest registered Ansible facts for the specified host.

  • URI /api/v1/noderoster/facts/last?hostName=${hostName}&hostId=${hostId}&offset=${offset}&limit=${limit}
  • Query parameters
    • hostName: name of the host;
    • hostId: ID of the host;
    • limit: maximum number of records to return;
    • offset: starting index from which to return.

    Either hostName or hostId must be specified.

  • Method GET
  • Headers Authorization
  • Body none

  • Success response

      Content-Type: application/json
    Copy
      {
    ...
  }
    Copy

Artifacts

Deployed Artifacts

Returns a (paginated) list of known artifacts deployed to the specified host.

  • URI /api/v1/noderoster/artifacts?hostName=${hostName}&hostId=${hostId}&offset=${offset}&limit=${limit}
  • Query parameters
    • hostName: name of the host;
    • hostId: ID of the host;
    • limit: maximum number of records to return;
    • offset: starting index from which to return.

    Either hostName or hostId must be specified.

  • Method GET
  • Headers Authorization
  • Body none

  • Success response

      Content-Type: application/json
    Copy
      [ {
    "url" : "http://localhost:53705/test.txt",
    "processInstanceId" : "5285f431-3551-4467-ad31-b43e9693eaab"
  } ]
    Copy

2011 - 2024 © Walmart Inc. All Rights Reserved.

Contribute to the site.

site footer image