You're not viewing the latest version. Click here to go to latest.
logo
Documentation
API Development
Initializing search
    GitLab
    • Home
    • Getting Started
    • Architectural Guide
    • Developer Guide
    • Operator Guide
    • Resources
    • Tags
    GitLab
      • Documentation
      • Digital Rebar Platform
      • Key Features
      • Editorial Style Guide
      • Markdown Notes
      • Redirect
    • Getting Started
      • Preparing to Run DRP
      • Install
        • Airgap Install
        • Cloud
        • Isolated
        • Container
      • Environments
        • AWS
        • DigitalOcean
        • ESXi Setup Instructions
        • Simple Hyper-V Setup
        • Hyper-V Setup
        • KVM using kvm-test plugin
        • Linode.com
        • Equinix Metal
        • VirtualBox
      • Post-Install Setup
      • Upgrade and Downgrade
      • Uninstall
      • Self-Managed Software
      • Trial
    • Architectural Guide
      • Deployment
        • Endpoint
          • How Authentication Works
          • Secure Parameter Architecture
          • Endpoint Architecture
          • Test Automation
        • High Availablity
        • Manager
        • Endpoint Sizing, Performance and Scaling Guide
      • Discovery
        • Discovery and Provisioning Operations
        • Sledgehammer Architecture
        • PXE
          • How dr-provision Boots Machines
          • DHCP Architecture
          • External DHCP Architecture
        • Scan
        • Join Up
        • Cloud
      • Provisioning
        • Building Universal Applications for DRP Pipelines
        • Universal Workflow Architecture
        • Hardware
          • Burnin
        • OS
          • Image Deploy
          • ESXi Node Ready
          • Eikon Architecture
        • Application
          • OpenShift
            • OpenShift Architecture
            • OpenShift Requirements
      • Concepts
        • Runner
          • Runner State and Reboots
          • Modes
            • Workflow Mode
            • Workorder
        • Clustering
          • Context Worker Architecture
          • Pooling Architecture
        • Batching
          • Batch Operations System Architecture
    • Developer Guide
      • API Automation
        • Swagger
        • DRP API
        • Using CURL
        • Go Client Library
        • Python Client Library
        • Example API Training Scenario
      • CLI Scripting/Automation
        • drpcli Usage
        • Basic Scripting
        • Basic Reporting
        • Call Examples
          • Job Operations
          • Machine Operations
          • Param Operations
          • Preference Operations
          • drpcli Usage
          • Reservations Operations
          • Stage Operations
          • Subnet Operations
          • Support Operations
          • Task Operations
          • Template Operations
          • User Operations
          • Workflow Operations
        • Filter Syntax
        • JQ Usage Examples
      • Automation Content
        • Content Generation
          • Contents Layout
          • Repo Layout
          • Object Generate Commands
        • Pipelines
        • Pipeline Elements
        • Tasks
          • Data Rendering
          • Repo Helpers
          • Task Templates
          • Standalone Cluster Profile (Deprecated)
        • Blueprints
        • Triggers
        • Bootenvs
        • Hardware Profiles
      • Plugins Construction
        • Developing Plugins
      • Contributing to RackN Repositories
        • Developing the CLI
        • Developing Documentation
        • Contributing to Plugins
        • Developer Best Practices
        • Setting up Dev Environment
    • Operator Guide
      • Deployment
        • CLI
        • Configuration
          • Configuring the Server
          • Deployments
          • Certificate Operations
          • IPv6 Provisioning
          • DHCP Operations
          • DNS Operations
          • Pooling Operations
          • Auth
            • User
            • Client Certificate
            • Active Directory
            • SAML-based Single Sign-On
            • Roles
            • Tenants
          • Secure Parameter Store
            • Vault Configuration
            • Command KeyVault Configuration
            • Azure KeyVault Configuration
            • AWS Secman Configuration
        • HA
          • High Availability
          • Status
        • Lifecycle
          • Backup and Restore
          • API Driven Upgrades
          • Machine Migration
          • Agent Deescalation
        • Manager
          • Manager Operations
          • Catalog Operations
          • Version Sets
          • Backup and Recovery
          • Create a Customer Catalog Repository
        • Security
          • Security FAQ
        • License Operations
          • RackN Licensing Overview
          • Activity
        • Content Packs and Plugins
          • DRP Agents in Kubernetes
          • Airgap Test Automation
          • AWS Secrets Manager
          • Azure KeyVault
          • Batch Library
          • Billing
          • BIOS Configuration
          • Blancco LUN Eraser
          • System Burn In
          • Callback
          • Certificate Mgmr (certs)
          • chef-bootstrap
          • Cisco Support
          • Classify Tests
          • Classify
          • Cloud Wrappers
          • Command KeyVault
          • Cohesity Appliance Reinstall
          • CoreOS
          • Dell Support
          • Dev Library
          • Docker (OCI) Execution Context
          • Community Core
          • Community Edge
          • Prometheus Monitoring
          • Edge Lab
          • Eikon Image Deploy
          • Endpoint Exec
          • Event To Audit
          • Filebeat Forwarder
          • Firmware Flash
          • FlexiFlow
          • Grafana Automation Tooling
          • HAProxy
          • Hardware Tooling
          • HashiCorp Tools
          • Honeycomb.io Synch
          • HPE Support
          • Image Builder
          • Image Deploy
          • Multi-API OOB/BMC Control
          • Kubernetes (KRIB)
          • Kubernetes Library
          • Kubespray2
          • Simple KVM Installation
          • KVM tester
          • Lenovo Support
          • Nagios Automation Tooling
          • NAPALM Network Automation
          • NetBox Sync
          • Openshift
          • OpsRamp Integration
          • RedHat O/S
          • oVirt API
          • Packer Builder Images
          • Packet.net API
          • Prometheus Automation Tooling
          • Proxmox Install and Configure
          • Rack Tracker
          • Openshift
          • RAID
          • RancherOS
          • Fake RO SSO
          • Simple Secrets
          • Slack Integration
          • Sledgehammer Builder (Centos 7)
          • Sledgehammer Builder
          • Solidfire
          • Supermicro Support
          • Core Task Library
          • Tenant Controller
          • Terraform
          • Test Automation
          • Tower Integration
          • kaholo-tools
          • ubuntuhammer Builder
          • Universal Workflow Examples
          • Universal Proxmox Content
          • Universal Workflow Content
          • Validation
          • Vault
          • VirtualBox IPMI
          • VMware Library
          • VMWare Support
      • Discovery
        • PXE Discovery
        • IPMI Scanning
        • Manual Join Up
        • Cloud-based Machines
        • LPAR Operations
        • Machine Identification
        • Inventory
        • Automatic Machine Classification in Infrastructure Pipelines
        • Virtual Media ISO Booting
      • Provisioning
        • Pipelines
        • Universal Workflow Operations
        • Hardware
          • Hardware Classification
          • Hardware Baselining
          • Using The BIOS Plugin
          • Hardware Raid
          • IPMI Plugin Usage
          • Hardware Repository Tarball
          • Hardware Repo Cloning
        • OS
          • Eikon Image Deploy
          • CentOS Image Build & Deployment Guide
          • Image Deploy Storage Examples
          • Image Building
          • OS Installation
          • OS Configuration
          • Universal Workflow Linux Provision
          • ESXi Getting Started Guide
        • Application
          • OpenShift
            • OpenShift Operations
            • Advanced Features
              • Advanced Cluster Management
              • Air-Gapped Installation
              • Custom Configuration
              • Advanced Features Integration
              • Security Features
            • OpenShift Troubleshooting
            • OpenShift Monitoring
      • Extensions
        • Setting Up Docker Contexts
        • How-to Set up a Context Worker Node Set
        • How-to Set up a Batch Operations System
        • Audit
        • Universal Workflow Cluster
        • Universal Resource Broker Operations
        • Accessing the Portal
        • Custom Branding Guide
        • Configuration
        • License Management
        • Metadata Fields
        • Uploading Content and Keys
        • UX Views
      • Legacy/Deprecated
        • Air Gap Install (deprecated)
        • Installing KRIB
      • Integrations
        • Ansible
        • Backstage
        • Jenkins
        • Terraform
        • Websocket Access
      • Trouble Shooting
      • Tags
      • Resources
      • Objects
        • Object Metadata
        • Networking Objects
          • DHCP Option
          • Lease
          • Reservation
          • Subnet
          • Zone
        • Runner Objects
          • Cluster
          • Context
          • Machine
          • Pool Object
          • Resource Broker
          • WorkOrder
        • Execution Objects
          • Job
          • Trigger Object
          • Trigger Provider
        • Content Objects
          • Blueprint
          • BootEnv
          • Param
          • Pipeline
          • Profile
          • Provision
          • Repo
          • Stage
          • Task
          • Template
          • Workflow
        • RBAC Objects
          • Identity Provider
          • Role
          • Tenant
          • User
        • Multi-Site Objects
          • Endpoint Object
          • Version Set Object
        • System Objects
          • Activity
          • Alert
          • Content
          • File
          • Interface
          • ISO
          • Plugin Provider
          • Plugin
          • Preference
          • UX View
        • Other Objects
          • IPMI Scan Result
          • Rack
      • Releases
        • Summary
        • Changes
        • v4.15 [Q1 2025]
        • v4.14 [December 2024]
        • v4.13 [February 2024]
        • v4.12 [July 2023]
        • v4.11 [January 2023]
        • v4.10 [August 2022]
        • v4.9 [March 2022]
        • v4.8 [December 2021]
        • v4.7 [Sept 2021]
        • v4.6 [April 2021]
        • v4.5 [Sept 2020]
        • v4.4 [July 2020]
        • v4.3 [June 2020]
        • v4.2 [December 2019]
        • v4.1 [Fall 2019]
        • v4.0 [August 2019]
        • v3.x
      • Knowledge Base (FAQ)
        • Where can I get the DRPCLI?
        • Where can I learn more about Digital Rebar Security?
        • Bind Error
        • TFTP Error
        • Generate Certificate
        • Add SSH Keys to Authorized Keys
        • Example Docker Volume Usage
        • Set SSH Root Mode
        • What are the default passwords?
        • Using the `.drpclirc` File
        • Using Table/Text Output Formatters
        • Command Line Interface FAQ
        • Turn Up the Debug
        • Debug Sledgehammer Problems
        • Convert Isolated Install to Production Mode
        • Customize Production Mode
        • Custom Kickstart and Preseeds
        • Can I eliminate reboots with kexec?
        • Import plugin failed pool: define failed
        • Update Community Content via Command Line
        • Rebooting inside a Tasks, Stages and Workflows
        • Rebooting without IPMI plugins (without a Task)
        • Nested Templates (or Sub-templates)
        • How Can I manipulate values during Golang Template rendering?
        • How Can I render Double Curly Braces `{{` and `}}` during Golang Template rendering?
        • Change a Machines Name
        • Set hostname in a DHCP Reservation
        • UEFI Boot Support - Option 67
        • lpxelinux.0 error: no such file or directory
        • Change Pxelinux Versions
        • Render a Kickstart or Preseed
        • BootEnv Does Not `Explode ISO` after upload
        • Booting Ubuntu Without External Access
        • Network Unreachable from Wget / Second Stage Timeout
        • Sledgehammer Boots Without IP
        • No matching Subnet (MacOS DHCP)
        • Kubernetes Dashboard
        • Expand Templates from Failed Job
        • RBAC - Limit Users to Just Poweron and Poweroff IPMI Controls
        • unblockRunnable Panic condition
        • Manager and System Time
        • JQ Usage Examples
        • Secure Boot Shim Bootloaders Fail With Proxy DHCP in UEFI Mode Booting
        • Example bootenvs-customize with Sledgehammer
        • Supported Image Deploy Image Formats
        • What are ExtraClaims
        • Git Basics with Digital Rebar
        • Content Upload Error with 'U+002D'
        • How To Update drpcli
        • Adding Secure Data to a Content Pack
        • Image-deploy requires a CentOS repo
        • Why use Digital Rebar integrated DHCP?
        • Updating Sledgehammer
        • VirtualMedia ISO Boot
        • Troubleshooting Runner does not connect
        • Troubleshooting Portal WebSockets
        • Parameter Precedence
        • Image Deploy with Curtin Partitions and XFS
        • Use Let's Encrypt Certificates with DRP
        • Working with Secure Params
        • Deploying Linux with Universal Workflows
        • Ubunto 20.04 Autoinstall Fails
        • How to use DRP as an HTTP/S File Server
        • Using 'drpcli' in Workflow
        • VMware Custom ISO
        • DRP Endpoint 'connect: connection refused' or 'i/o timeout' errors
        • Storing Multi-Line Strings in Params
        • No YUM or APT packages for Digital Rebar
        • Icons for 'Meta.icon' field in content objects
        • How to Update MAC Addresses for Machine (eg change NIC)
        • DHCP Ignoring Request Message
        • Proxy Allow List
        • What OS and Architectures does 'drpcli' run on?
        • Building 'drpcli' client binary and agent.
        • Using Universal Callbacks
        • Time Units for Tokens
        • Running Workflow on a MacOS System
        • Generating Scoped Tokens
        • Using ISOFS To Save Space
        • Install Context Containers with 'drpcli'
        • Proxmox VM create fails with tls_process_server_certificate error
        • dr-provision fails with error 312
        • Proxmox Cluster Operations Fail with "WorkOrder failed"
        • How-To Make Labs
        • 0000 Sample Lab
        • 1000 Install Digital Rebar
        • 1001 Leveraging Labs
        • 1005 Tour the Digital Rebar UX
        • 1010 Manage Groups of Machines using Clusters
        • 1015 Build a Cluster using Machine Pools
        • 1020 Build a Multi-Cloud Cluster using Pre-Defined Terraform
        • 1030 Detect Terraform Drift
        • 1040 Find Orphaned AWS Instances
        • 1050 Create an Alert when Content is updated
        • 1200 Start Remote Access
        • 2000 Working with the Digital Rebar CLI
        • 2010 Create a Custom UX Action Button
        • 2020 Notify Slack when Alerts Arrive
        • 2060 Override Cluster and Machine Pipelines
        • 2070 Create a Cluster with Named Machines
        • 2080 Run Ad Hoc tasks on Machines
        • 3010 Create Your Own Blueprint to Repond to Triggers
        • 3060 Worker Queues Process High Activity Triggers
      • Security
        • CVE-2020-0924a
        • CVE-2022-46382
        • CVE-2022-46383
        • CVE-2024-RKN0001
        • CVE-2024-RKN0002
      • All
        • Explanation
        • How-To
        • Tutorial
        • Reference
        • Architecture
        • Developer
        • Operator
      • content
      • Deploy
      • DRPCLI
      • Object
      • Pattern
      • Release
    api developer reference

    API Automation

    Information on how to make API calls.

    Copyright © 2023 RackN Inc. – Change cookie settings
    Made with Material for MkDocs Insiders

    Cookie consent

    We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.