NetBox Labs vendor logo

Vendor

NetBox Labs

Product

NetBox

Method

REST

Category

Inventory

Network Services

Project Type

Adapter


View Repository
Adapter

Adapter for Integration to NetBox Labs NetBox v2.1.0

Overview

This adapter is used to integrate the Itential Automation Platform (IAP) with the Netbox_v210 System. The API that was used to build the adapter for Netbox_v210 is usually available in the report directory of this adapter. The adapter utilizes the Netbox_v210 API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.

For further technical details on how to install and use this adapter, please click the Technical Documentation tab.

Netbox_v210

Table of Contents

Getting Started

These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.

Helpful Background Information

There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:

Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an Adapter

Others will be added over time. Want to build a new adapter? Use the Itential Adapter Builder

Prerequisites

The following is a list of required packages for installation on the system the adapter will run on:

Node.js
npm
Git

The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.

PackageDescription
@itentialopensource/adapter-utilsRuntime library classes for all adapters; includes request handling, connection, authentication throttling, and translation.
ajvRequired for validation of adapter properties to integrate with Netbox_v210.
axiosUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
commanderUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
dns-lookup-promiseUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
fs-extraUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
mochaTesting library that is utilized by some of the node scripts that are included with the adapter.
mocha-paramTesting library that is utilized by some of the node scripts that are included with the adapter.
mongodbUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
nycTesting coverage library that is utilized by some of the node scripts that are included with the adapter.
pingUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
readline-syncUtilized by the node script that comes with the adapter; helps to test unit and integration functionality.
semverUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.
winstonUtilized by the node scripts that are included with the adapter; helps to build and extend the functionality.

If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.

chai
eslint
eslint-config-airbnb-base
eslint-plugin-import
eslint-plugin-json
testdouble

How to Install

  1. Set up the name space location in your IAP node_modules.
cd /opt/pronghorn/current/node_modules (* could be in a different place)
if the @itentialopensource directory does not exist, create it:
    mkdir @itentialopensource
  1. Clone/unzip/tar the adapter into your IAP environment.
cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-netbox_v210
or
unzip adapter-netbox_v210.zip
or
tar -xvf adapter-netbox_v210.tar
  1. Run the adapter install script.
cd adapter-netbox_v210
npm install
npm run lint:errors
npm run test
  1. Restart IAP
systemctl restart pronghorn
  1. Create an adapter service instance configuration in IAP Admin Essentials GUI

  2. Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.

  3. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:

  1. Install adapter dependencies and check the adapter.
cd adapter-netbox_v210
npm run adapter:install
  1. Restart IAP
systemctl restart pronghorn
  1. Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI

Testing

Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.

Unit Testing

Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.

node utils/testRunner --unit

npm run test:unit
npm run test:baseunit

To add new unit tests, edit the test/unit/adapterTestUnit.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing - Standalone

Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from Netbox_v210. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.

Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.

node utils/testRunner
  answer no at the first prompt

npm run test:integration

To add new integration tests, edit the test/integration/adapterTestIntegration.js file. The tests that are already in this file should provide guidance for adding additional tests.

Integration Testing

Integration Testing requires connectivity to Netbox_v210. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.

Note: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for creates and updates. Hence, integration tests may have to be enhanced before they will work (integrate) with Netbox_v210. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within Netbox_v210 which change order dependencies or required data.

node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentials

Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.

Reminder: Do not check in code with actual credentials to systems.

Configuration

This section defines all the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.

Example Properties

  "properties": {
    "host": "netbox.core-services.test.leaseplan.systems",
    "port": 443,
    "choosepath": "",
    "base_path": "/api",
    "version": "",
    "cache_location": "none",
    "encode_pathvars": true,
    "encode_queryvars": true,
    "save_metric": false,
    "stub": true,
    "protocol": "https",
    "authentication": {
      "auth_method": "basic user_password",
      "username": "username",
      "password": "password",
      "token": "token",
      "token_timeout": 600000,
      "token_cache": "local",
      "invalid_token_error": 401,
      "auth_field": "header.headers.Authorization",
      "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
      "auth_logging": false,
      "client_id": "",
      "client_secret": "",
      "grant_type": "",
      "sensitive": [],
      "sso": {
        "protocol": "",
        "host": "",
        "port": 0
      },
      "multiStepAuthCalls": [
        {
          "name": "",
          "requestFields": {},
          "responseFields": {},
          "successfullResponseCode": 200
        }
      ]
    },
    "healthcheck": {
      "type": "intermittent",
      "frequency": 600000,
      "query_object": {},
      "addlHeaders": {}
    },
    "throttle": {
      "throttle_enabled": false,
      "number_pronghorns": 1,
      "sync_async": "sync",
      "max_in_queue": 1000,
      "concurrent_max": 1,
      "expire_timeout": 0,
      "avg_runtime": 200,
      "priorities": [
        {
          "value": 0,
          "percent": 100
        }
      ]
    },
    "request": {
      "number_redirects": 0,
      "number_retries": 3,
      "limit_retry_error": [
        0
      ],
      "failover_codes": [],
      "attempt_timeout": 5000,
      "global_request": {
        "payload": {},
        "uriOptions": {},
        "addlHeaders": {},
        "authData": {}
      },
      "healthcheck_on_timeout": true,
      "return_raw": false,
      "archiving": false,
      "return_request": false
    },
    "proxy": {
      "enabled": false,
      "host": "",
      "port": 1,
      "protocol": "http",
      "username": "",
      "password": ""
    },
    "ssl": {
      "ecdhCurve": "",
      "enabled": false,
      "accept_invalid_cert": false,
      "ca_file": "",
      "key_file": "",
      "cert_file": "",
      "secure_protocol": "",
      "ciphers": ""
    },
    "mongo": {
      "host": "",
      "port": 0,
      "database": "",
      "username": "",
      "password": "",
      "replSet": "",
      "db_ssl": {
        "enabled": false,
        "accept_invalid_cert": false,
        "ca_file": "",
        "key_file": "",
        "cert_file": ""
      }
    },
    "devicebroker": {
      "getDevice": [
        {
          "path": "/get/devices/{id}",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "getDevicesFiltered": [
        {
          "path": "/get/devices",
          "method": "GET",
          "pagination": {
            "offsetVar": "",
            "limitVar": "",
            "incrementBy": "limit",
            "requestLocation": "query"
          },
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {
            "name": "host",
            "ostype": "os",
            "ostypePrefix": "system-",
            "ipaddress": "attributes.ipaddr",
            "port": "443"
          }
        }
      ],
      "isAlive": [
        {
          "path": "/get/devices/{id}/status",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {
            "status": "status",
            "statusValue": "online"
          }
        }
      ],
      "getConfig": [
        {
          "path": "/get/devices/{id}/configPart1",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {
            "id": "name"
          },
          "responseDatakey": "",
          "responseFields": {}
        }
      ],
      "getCount": [
        {
          "path": "/get/devices",
          "method": "GET",
          "query": {},
          "body": {},
          "headers": {},
          "handleFailure": "ignore",
          "requestFields": {},
          "responseDatakey": "",
          "responseFields": {}
        }
      ]
    },
    "cache": {
      "enabled": false,
      "entities": [
        {
          "entityType": "",
          "frequency": 1440,
          "flushOnFail": false,
          "limit": 1000,
          "retryAttempts": 5,
          "sort": true,
          "populate": [
            {
              "path": "",
              "method": "GET",
              "pagination": {
                "offsetVar": "",
                "limitVar": "",
                "incrementBy": "limit",
                "requestLocation": "query"
              },
              "query": {},
              "body": {},
              "headers": {},
              "handleFailure": "ignore",
              "requestFields": {},
              "responseDatakey": "",
              "responseFields": {}
            }
          ],
          "cachedTasks": [
            {
              "name": "",
              "filterField": "",
              "filterLoc": ""
            }
          ]
        }
      ]
    }
  }

Connection Properties

These base properties are used to connect to Netbox_v210 upon the adapter initially coming up. It is important to set these properties appropriately.

PropertyDescription
hostRequired. A fully qualified domain name or IP address.
portRequired. Used to connect to the server.
base_pathOptional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``.
versionOptional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``.
cache_locationOptional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list.
encode_pathvarsOptional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior.
encode_queryvarsOptional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior.
save_metricOptional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system.
stubOptional. Indicates whether the stub should run instead of making calls to Netbox_v210 (very useful during basic testing). Default is false (which means connect to Netbox_v210).
protocolOptional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP.

A connectivity check tells IAP the adapter has loaded successfully.

Authentication Properties

The following properties are used to define the authentication process to Netbox_v210.

Note: Depending on the method that is used to authenticate with Netbox_v210, you may not need to set all of the authentication properties.

PropertyDescription
auth_methodRequired. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`.
usernameUsed to authenticate with Netbox_v210 on every request or when pulling a token that will be used in subsequent requests.
passwordUsed to authenticate with Netbox_v210 on every request or when pulling a token that will be used in subsequent requests.
tokenDefines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method).
invalid_token_errorDefines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401.
token_timeoutDefines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to Netbox_v210. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid.
token_cacheUsed to determine where the token should be stored (local memory or in Redis).
auth_fieldDefines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work.
auth_field_formatDefines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item.
auth_loggingSetting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true.
client_idProvide a client id when needed, this is common on some types of OAuth.
client_secretProvide a client secret when needed, this is common on some types of OAuth.
grant_typeProvide a grant type when needed, this is common on some types of OAuth.

Examples of authentication field format

"{token}"
"Token {token}"
"{username}:{password}"
"Basic {b64}{username}:{password}{/b64}"

Healthcheck Properties

The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach Netbox_v210. There are currently three types of healthchecks.

  • None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach Netbox_v210.
  • Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
  • Intermittent - Adapter will check connectivity to Netbox_v210 at a frequency defined in the frequency property.
PropertyDescription
typeRequired. The type of health check to run.
frequencyRequired if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000.
query_objectQuery parameters to be added to the adapter healthcheck call.

Request Properties

The request section defines properties to help handle requests.

PropertyDescription
number_redirectsOptional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects.
number_retriesTells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error.
limit_retry_errorOptional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0].
failover_codesAn array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter.
attempt_timeoutOptional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to Netbox_v210, and then will re-attempt the request that aborted. Default is 5000 milliseconds.
global_requestOptional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files.
global_request -> payloadOptional. Defines any information that should be included on all requests sent to the other system that have a payload/body.
global_request -> uriOptionsOptional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system.
global_request -> addlHeadersOptioonal. Defines any headers that should be sent on all requests to the other system.
global_request -> authDataOptional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request.
healthcheck_on_timeoutRequired. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request.
return_rawOptional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production.
archivingOptional flag. Default is false. It archives the request, the results and the various times (wait time, Netbox_v210 time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large.
return_requestOptional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request.

SSL Properties

The SSL section defines the properties utilized for ssl authentication with Netbox_v210. SSL can work two different ways: set the accept\_invalid\_certs flag to true (only recommended for lab environments), or provide a ca\_file.

PropertyDescription
enabledIf SSL is required, set to true.
accept_invalid_certsDefines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
ca_fileDefines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
key_fileDefines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
cert_fileDefines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.
secure_protocolDefines the protocol (e.g., SSLv3_method) to use on the SSL request.
ciphersRequired if SSL enabled. Specifies a list of SSL ciphers to use.
ecdhCurveDuring testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9.

Throttle Properties

The throttle section is used when requests to Netbox_v210 must be queued (throttled). All of the properties in this section are optional.

PropertyDescription
throttle_enabledDefault is false. Defines if the adapter should use throttling or not.
number_pronghornsDefault is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead.
sync-asyncThis property is not used at the current time (it is for future expansion of the throttling engine).
max_in_queueRepresents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000.
concurrent_maxDefines the number of requests the adapter can send to Netbox_v210 at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to Netbox_v210 in a serial manner.
expire_timeoutDefault is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000).
average_runtimeRepresents the approximate average of how long it takes Netbox_v210 to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when Netbox_v210 performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently.
prioritiesAn array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 }

Proxy Properties

The proxy section defines the properties to utilize when Netbox_v210 is behind a proxy server.

PropertyDescription
enabledRequired. Default is false. If Netbox_v210 is behind a proxy server, set enabled flag to true.
hostHost information for the proxy server. Required if `enabled` is true.
portPort information for the proxy server. Required if `enabled` is true.
protocolThe protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http.
usernameIf there is authentication for the proxy, provide the username here.
passwordIf there is authentication for the proxy, provide the password here.

Mongo Properties

The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.

PropertyDescription
hostOptional. Host information for the mongo server.
portOptional. Port information for the mongo server.
databaseOptional. The database for the adapter to use for its data.
usernameOptional. If credentials are required to access mongo, this is the user to login as.
passwordOptional. If credentials are required to access mongo, this is the password to login with.
replSetOptional. If the database is set up to use replica sets, define it here so it can be added to the database connection.
db_sslOptional. Contains information for SSL connectivity to the database.
db_ssl -> enabledIf SSL is required, set to true.
db_ssl -> accept_invalid_certDefines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false.
db_ssl -> ca_fileDefines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required.
db_ssl -> key_fileDefines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL.
db_ssl -> cert_fileDefines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL.

Device Broker Properties

The device broker section defines the properties used integrate Netbox_v210 to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.

PropertyDescription
getDeviceThe array of calls used to get device details for the broker
getDevicesFilteredThe array of calls used to get devices for the broker
isAliveThe array of calls used to get device status for the broker
getConfigThe array of calls used to get device configuration for the broker
getCountThe array of calls used to get device configuration for the broker
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> pathThe path, not including the base_path and version, for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> methodThe rest method for making this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> queryQuery object containing and query parameters and their values for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> bodyBody object containing the payload for this call
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headersHeader object containing the headers for this call.
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailureTells the adapter whether to "fail" or "ignore" failures if they occur.
isAlive -> statusValueTells the adapter what value to look for in the status field to determine if the device is alive.
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFieldsObject containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value.
getDevice/getDevicesFiltered/isAlive/getConfig -> responseFieldsObject containing fields the adapter should set to send back to iap and where the value should come from in the response or request data.

Using this Adapter

The adapter.js file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.

Generic Adapter Calls

These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.

Method SignatureDescriptionWorkflow?
connect()This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.No
healthCheck(callback)This call ensures that the adapter can communicate with Netbox_v210. The actual call that is used is defined in the adapter properties and .system entities action.json file.No
refreshProperties(properties)This call provides the adapter the ability to accept property changes without having to restart the adapter.No
encryptProperty(property, technique, callback)This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Netbox_v210.No
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.Yes
iapFindAdapterPath(apiPath, callback)This call provides the ability to see if a particular API path is supported by the adapter.Yes
iapSuspendAdapter(mode, callback)This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.Yes
iapUnsuspendAdapter(callback)This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.Yes
iapGetAdapterQueue(callback)This call will return the requests that are waiting in the queue if throttling is enabled.Yes
iapTroubleshootAdapter(props, persistFlag, adapter, callback)This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.Yes
iapRunAdapterHealthcheck(adapter, callback)This call will return the results of a healthcheck.Yes
iapRunAdapterConnectivity(callback)This call will return the results of a connectivity check.Yes
iapRunAdapterBasicGet(callback)This call will return the results of running basic get API calls.Yes
iapMoveAdapterEntitiesToDB(callback)This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.Yes
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.Yes
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.Yes
iapHasAdapterEntity(entityType, entityId, callback)This call verifies the adapter has the specific entity.No
iapVerifyAdapterCapability(entityType, actionType, entityId, callback)This call verifies the adapter can perform the provided action on the specific entity.No
iapUpdateAdapterEntityCache()This call will update the entity cache.No

Adapter Broker Calls

These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.

Method SignatureDescriptionWorkflow?
hasEntities(entityType, entityList, callback)This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.No
getDevice(deviceName, callback)This call returns the details of the requested device.Yes
getDevicesFiltered(options, callback)This call returns the list of devices that match the criteria provided in the options filter.Yes
isAlive(deviceName, callback)This call returns whether the device status is activeYes
getConfig(deviceName, format, callback)This call returns the configuration for the selected device.Yes
iapGetDeviceCount(callback)This call returns the count of devices.Yes

Specific Adapter Calls

Specific adapter calls are built based on the API of the Netbox_v210. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.

Method SignatureDescriptionPathWorkflow?
getCircuitsCircuitTerminations(termSide, portSpeed, upstreamSpeed, xconnectId, cabled, connected, q, circuitId, siteId, site, termSideN, portSpeedN, portSpeedLte, portSpeedLt, portSpeedGte, portSpeedGt, upstreamSpeedN, upstreamSpeedLte, upstreamSpeedLt, upstreamSpeedGte, upstreamSpeedGt, xconnectIdN, xconnectIdIc, xconnectIdNic, xconnectIdIew, xconnectIdNiew, xconnectIdIsw, xconnectIdNisw, xconnectIdIe, xconnectIdNie, circuitIdN, siteIdN, siteN, limit, offset, callback)circuits_circuit-terminations_list{base_path}/{version}/circuits/circuit-terminations/?{query}Yes
postCircuitsCircuitTerminations(data, callback)circuits_circuit-terminations_create{base_path}/{version}/circuits/circuit-terminations/?{query}Yes
putCircuitsCircuitTerminations(data, callback)circuits_circuit-terminations_bulk_update{base_path}/{version}/circuits/circuit-terminations/?{query}Yes
patchCircuitsCircuitTerminations(data, callback)circuits_circuit-terminations_bulk_partial_update{base_path}/{version}/circuits/circuit-terminations/?{query}Yes
deleteCircuitsCircuitTerminations(callback)circuits_circuit-terminations_bulk_delete{base_path}/{version}/circuits/circuit-terminations/?{query}Yes
getCircuitsCircuitTerminationsId(id, callback)circuits_circuit-terminations_read{base_path}/{version}/circuits/circuit-terminations/{pathv1}/?{query}Yes
putCircuitsCircuitTerminationsId(id, data, callback)circuits_circuit-terminations_update{base_path}/{version}/circuits/circuit-terminations/{pathv1}/?{query}Yes
patchCircuitsCircuitTerminationsId(id, data, callback)circuits_circuit-terminations_partial_update{base_path}/{version}/circuits/circuit-terminations/{pathv1}/?{query}Yes
deleteCircuitsCircuitTerminationsId(id, callback)circuits_circuit-terminations_delete{base_path}/{version}/circuits/circuit-terminations/{pathv1}/?{query}Yes
getCircuitsCircuitTerminationsIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/circuits/circuit-terminations/{pathv1}/trace/?{query}Yes
getCircuitsCircuitTypes(id, name, slug, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, limit, offset, callback)circuits_circuit-types_list{base_path}/{version}/circuits/circuit-types/?{query}Yes
postCircuitsCircuitTypes(data, callback)circuits_circuit-types_create{base_path}/{version}/circuits/circuit-types/?{query}Yes
putCircuitsCircuitTypes(data, callback)circuits_circuit-types_bulk_update{base_path}/{version}/circuits/circuit-types/?{query}Yes
patchCircuitsCircuitTypes(data, callback)circuits_circuit-types_bulk_partial_update{base_path}/{version}/circuits/circuit-types/?{query}Yes
deleteCircuitsCircuitTypes(callback)circuits_circuit-types_bulk_delete{base_path}/{version}/circuits/circuit-types/?{query}Yes
getCircuitsCircuitTypesId(id, callback)circuits_circuit-types_read{base_path}/{version}/circuits/circuit-types/{pathv1}/?{query}Yes
putCircuitsCircuitTypesId(id, data, callback)circuits_circuit-types_update{base_path}/{version}/circuits/circuit-types/{pathv1}/?{query}Yes
patchCircuitsCircuitTypesId(id, data, callback)circuits_circuit-types_partial_update{base_path}/{version}/circuits/circuit-types/{pathv1}/?{query}Yes
deleteCircuitsCircuitTypesId(id, callback)circuits_circuit-types_delete{base_path}/{version}/circuits/circuit-types/{pathv1}/?{query}Yes
getCircuitsCircuits(id, cid, installDate, commitRate, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, providerId, provider, typeId, type, status, siteId, site, regionId, region, tag, idN, idLte, idLt, idGte, idGt, cidN, cidIc, cidNic, cidIew, cidNiew, cidIsw, cidNisw, cidIe, cidNie, installDateN, installDateLte, installDateLt, installDateGte, installDateGt, commitRateN, commitRateLte, commitRateLt, commitRateGte, commitRateGt, tenantGroupIdN, callback)circuits_circuits_list{base_path}/{version}/circuits/circuits/?{query}Yes
postCircuitsCircuits(data, callback)circuits_circuits_create{base_path}/{version}/circuits/circuits/?{query}Yes
putCircuitsCircuits(data, callback)circuits_circuits_bulk_update{base_path}/{version}/circuits/circuits/?{query}Yes
patchCircuitsCircuits(data, callback)circuits_circuits_bulk_partial_update{base_path}/{version}/circuits/circuits/?{query}Yes
deleteCircuitsCircuits(callback)circuits_circuits_bulk_delete{base_path}/{version}/circuits/circuits/?{query}Yes
getCircuitsCircuitsId(id, callback)circuits_circuits_read{base_path}/{version}/circuits/circuits/{pathv1}/?{query}Yes
putCircuitsCircuitsId(id, data, callback)circuits_circuits_update{base_path}/{version}/circuits/circuits/{pathv1}/?{query}Yes
patchCircuitsCircuitsId(id, data, callback)circuits_circuits_partial_update{base_path}/{version}/circuits/circuits/{pathv1}/?{query}Yes
deleteCircuitsCircuitsId(id, callback)circuits_circuits_delete{base_path}/{version}/circuits/circuits/{pathv1}/?{query}Yes
getCircuitsProviders(id, name, slug, asn, account, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, regionId, region, siteId, site, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, asnN, asnLte, asnLt, asnGte, asnGt, accountN, accountIc, accountNic, accountIew, accountNiew, callback)circuits_providers_list{base_path}/{version}/circuits/providers/?{query}Yes
postCircuitsProviders(data, callback)circuits_providers_create{base_path}/{version}/circuits/providers/?{query}Yes
putCircuitsProviders(data, callback)circuits_providers_bulk_update{base_path}/{version}/circuits/providers/?{query}Yes
patchCircuitsProviders(data, callback)circuits_providers_bulk_partial_update{base_path}/{version}/circuits/providers/?{query}Yes
deleteCircuitsProviders(callback)circuits_providers_bulk_delete{base_path}/{version}/circuits/providers/?{query}Yes
getCircuitsProvidersId(id, callback)circuits_providers_read{base_path}/{version}/circuits/providers/{pathv1}/?{query}Yes
putCircuitsProvidersId(id, data, callback)circuits_providers_update{base_path}/{version}/circuits/providers/{pathv1}/?{query}Yes
patchCircuitsProvidersId(id, data, callback)circuits_providers_partial_update{base_path}/{version}/circuits/providers/{pathv1}/?{query}Yes
deleteCircuitsProvidersId(id, callback)circuits_providers_delete{base_path}/{version}/circuits/providers/{pathv1}/?{query}Yes
getDcimCables(id, label, length, lengthUnit, q, type, status, color, deviceId, device, rackId, rack, siteId, site, tenantId, tenant, tag, idN, idLte, idLt, idGte, idGt, labelN, labelIc, labelNic, labelIew, labelNiew, labelIsw, labelNisw, labelIe, labelNie, lengthN, lengthLte, lengthLt, lengthGte, lengthGt, lengthUnitN, typeN, statusN, colorN, tagN, limit, offset, callback)dcim_cables_list{base_path}/{version}/dcim/cables/?{query}Yes
postDcimCables(data, callback)dcim_cables_create{base_path}/{version}/dcim/cables/?{query}Yes
putDcimCables(data, callback)dcim_cables_bulk_update{base_path}/{version}/dcim/cables/?{query}Yes
patchDcimCables(data, callback)dcim_cables_bulk_partial_update{base_path}/{version}/dcim/cables/?{query}Yes
deleteDcimCables(callback)dcim_cables_bulk_delete{base_path}/{version}/dcim/cables/?{query}Yes
getDcimCablesId(id, callback)dcim_cables_read{base_path}/{version}/dcim/cables/{pathv1}/?{query}Yes
putDcimCablesId(id, data, callback)dcim_cables_update{base_path}/{version}/dcim/cables/{pathv1}/?{query}Yes
patchDcimCablesId(id, data, callback)dcim_cables_partial_update{base_path}/{version}/dcim/cables/{pathv1}/?{query}Yes
deleteDcimCablesId(id, callback)dcim_cables_delete{base_path}/{version}/dcim/cables/{pathv1}/?{query}Yes
getDcimConnectedDevice(peerDevice, peerInterface, callback)This endpoint allows a user to determine what device (if any) is connected to a given peer device a{base_path}/{version}/dcim/connected-device/?{query}Yes
getDcimConsoleConnections(name, site, deviceId, device, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, limit, offset, callback)dcim_console-connections_list{base_path}/{version}/dcim/console-connections/?{query}Yes
getDcimConsolePortTemplates(id, name, type, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, devicetypeIdN, limit, offset, callback)dcim_console-port-templates_list{base_path}/{version}/dcim/console-port-templates/?{query}Yes
postDcimConsolePortTemplates(data, callback)dcim_console-port-templates_create{base_path}/{version}/dcim/console-port-templates/?{query}Yes
putDcimConsolePortTemplates(data, callback)dcim_console-port-templates_bulk_update{base_path}/{version}/dcim/console-port-templates/?{query}Yes
patchDcimConsolePortTemplates(data, callback)dcim_console-port-templates_bulk_partial_update{base_path}/{version}/dcim/console-port-templates/?{query}Yes
deleteDcimConsolePortTemplates(callback)dcim_console-port-templates_bulk_delete{base_path}/{version}/dcim/console-port-templates/?{query}Yes
getDcimConsolePortTemplatesId(id, callback)dcim_console-port-templates_read{base_path}/{version}/dcim/console-port-templates/{pathv1}/?{query}Yes
putDcimConsolePortTemplatesId(id, data, callback)dcim_console-port-templates_update{base_path}/{version}/dcim/console-port-templates/{pathv1}/?{query}Yes
patchDcimConsolePortTemplatesId(id, data, callback)dcim_console-port-templates_partial_update{base_path}/{version}/dcim/console-port-templates/{pathv1}/?{query}Yes
deleteDcimConsolePortTemplatesId(id, callback)dcim_console-port-templates_delete{base_path}/{version}/dcim/console-port-templates/{pathv1}/?{query}Yes
getDcimConsolePorts(id, name, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, connected, type, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, deviceIdN, deviceN, tagN, typeN, limit, offset, callback)dcim_console-ports_list{base_path}/{version}/dcim/console-ports/?{query}Yes
postDcimConsolePorts(data, callback)dcim_console-ports_create{base_path}/{version}/dcim/console-ports/?{query}Yes
putDcimConsolePorts(data, callback)dcim_console-ports_bulk_update{base_path}/{version}/dcim/console-ports/?{query}Yes
patchDcimConsolePorts(data, callback)dcim_console-ports_bulk_partial_update{base_path}/{version}/dcim/console-ports/?{query}Yes
deleteDcimConsolePorts(callback)dcim_console-ports_bulk_delete{base_path}/{version}/dcim/console-ports/?{query}Yes
getDcimConsolePortsId(id, callback)dcim_console-ports_read{base_path}/{version}/dcim/console-ports/{pathv1}/?{query}Yes
putDcimConsolePortsId(id, data, callback)dcim_console-ports_update{base_path}/{version}/dcim/console-ports/{pathv1}/?{query}Yes
patchDcimConsolePortsId(id, data, callback)dcim_console-ports_partial_update{base_path}/{version}/dcim/console-ports/{pathv1}/?{query}Yes
deleteDcimConsolePortsId(id, callback)dcim_console-ports_delete{base_path}/{version}/dcim/console-ports/{pathv1}/?{query}Yes
getDcimConsolePortsIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/dcim/console-ports/{pathv1}/trace/?{query}Yes
getDcimConsoleServerPortTemplates(id, name, type, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, devicetypeIdN, limit, offset, callback)dcim_console-server-port-templates_list{base_path}/{version}/dcim/console-server-port-templates/?{query}Yes
postDcimConsoleServerPortTemplates(data, callback)dcim_console-server-port-templates_create{base_path}/{version}/dcim/console-server-port-templates/?{query}Yes
putDcimConsoleServerPortTemplates(data, callback)dcim_console-server-port-templates_bulk_update{base_path}/{version}/dcim/console-server-port-templates/?{query}Yes
patchDcimConsoleServerPortTemplates(data, callback)dcim_console-server-port-templates_bulk_partial_update{base_path}/{version}/dcim/console-server-port-templates/?{query}Yes
deleteDcimConsoleServerPortTemplates(callback)dcim_console-server-port-templates_bulk_delete{base_path}/{version}/dcim/console-server-port-templates/?{query}Yes
getDcimConsoleServerPortTemplatesId(id, callback)dcim_console-server-port-templates_read{base_path}/{version}/dcim/console-server-port-templates/{pathv1}/?{query}Yes
putDcimConsoleServerPortTemplatesId(id, data, callback)dcim_console-server-port-templates_update{base_path}/{version}/dcim/console-server-port-templates/{pathv1}/?{query}Yes
patchDcimConsoleServerPortTemplatesId(id, data, callback)dcim_console-server-port-templates_partial_update{base_path}/{version}/dcim/console-server-port-templates/{pathv1}/?{query}Yes
deleteDcimConsoleServerPortTemplatesId(id, callback)dcim_console-server-port-templates_delete{base_path}/{version}/dcim/console-server-port-templates/{pathv1}/?{query}Yes
getDcimConsoleServerPorts(id, name, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, connected, type, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, deviceIdN, deviceN, tagN, typeN, limit, offset, callback)dcim_console-server-ports_list{base_path}/{version}/dcim/console-server-ports/?{query}Yes
postDcimConsoleServerPorts(data, callback)dcim_console-server-ports_create{base_path}/{version}/dcim/console-server-ports/?{query}Yes
putDcimConsoleServerPorts(data, callback)dcim_console-server-ports_bulk_update{base_path}/{version}/dcim/console-server-ports/?{query}Yes
patchDcimConsoleServerPorts(data, callback)dcim_console-server-ports_bulk_partial_update{base_path}/{version}/dcim/console-server-ports/?{query}Yes
deleteDcimConsoleServerPorts(callback)dcim_console-server-ports_bulk_delete{base_path}/{version}/dcim/console-server-ports/?{query}Yes
getDcimConsoleServerPortsId(id, callback)dcim_console-server-ports_read{base_path}/{version}/dcim/console-server-ports/{pathv1}/?{query}Yes
putDcimConsoleServerPortsId(id, data, callback)dcim_console-server-ports_update{base_path}/{version}/dcim/console-server-ports/{pathv1}/?{query}Yes
patchDcimConsoleServerPortsId(id, data, callback)dcim_console-server-ports_partial_update{base_path}/{version}/dcim/console-server-ports/{pathv1}/?{query}Yes
deleteDcimConsoleServerPortsId(id, callback)dcim_console-server-ports_delete{base_path}/{version}/dcim/console-server-ports/{pathv1}/?{query}Yes
getDcimConsoleServerPortsIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/dcim/console-server-ports/{pathv1}/trace/?{query}Yes
getDcimDeviceBayTemplates(id, name, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, devicetypeIdN, limit, offset, callback)dcim_device-bay-templates_list{base_path}/{version}/dcim/device-bay-templates/?{query}Yes
postDcimDeviceBayTemplates(data, callback)dcim_device-bay-templates_create{base_path}/{version}/dcim/device-bay-templates/?{query}Yes
putDcimDeviceBayTemplates(data, callback)dcim_device-bay-templates_bulk_update{base_path}/{version}/dcim/device-bay-templates/?{query}Yes
patchDcimDeviceBayTemplates(data, callback)dcim_device-bay-templates_bulk_partial_update{base_path}/{version}/dcim/device-bay-templates/?{query}Yes
deleteDcimDeviceBayTemplates(callback)dcim_device-bay-templates_bulk_delete{base_path}/{version}/dcim/device-bay-templates/?{query}Yes
getDcimDeviceBayTemplatesId(id, callback)dcim_device-bay-templates_read{base_path}/{version}/dcim/device-bay-templates/{pathv1}/?{query}Yes
putDcimDeviceBayTemplatesId(id, data, callback)dcim_device-bay-templates_update{base_path}/{version}/dcim/device-bay-templates/{pathv1}/?{query}Yes
patchDcimDeviceBayTemplatesId(id, data, callback)dcim_device-bay-templates_partial_update{base_path}/{version}/dcim/device-bay-templates/{pathv1}/?{query}Yes
deleteDcimDeviceBayTemplatesId(id, callback)dcim_device-bay-templates_delete{base_path}/{version}/dcim/device-bay-templates/{pathv1}/?{query}Yes
getDcimDeviceBays(id, name, description, q, regionId, region, siteId, site, deviceId, device, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, deviceIdN, deviceN, tagN, limit, offset, callback)dcim_device-bays_list{base_path}/{version}/dcim/device-bays/?{query}Yes
postDcimDeviceBays(data, callback)dcim_device-bays_create{base_path}/{version}/dcim/device-bays/?{query}Yes
putDcimDeviceBays(data, callback)dcim_device-bays_bulk_update{base_path}/{version}/dcim/device-bays/?{query}Yes
patchDcimDeviceBays(data, callback)dcim_device-bays_bulk_partial_update{base_path}/{version}/dcim/device-bays/?{query}Yes
deleteDcimDeviceBays(callback)dcim_device-bays_bulk_delete{base_path}/{version}/dcim/device-bays/?{query}Yes
getDcimDeviceBaysId(id, callback)dcim_device-bays_read{base_path}/{version}/dcim/device-bays/{pathv1}/?{query}Yes
putDcimDeviceBaysId(id, data, callback)dcim_device-bays_update{base_path}/{version}/dcim/device-bays/{pathv1}/?{query}Yes
patchDcimDeviceBaysId(id, data, callback)dcim_device-bays_partial_update{base_path}/{version}/dcim/device-bays/{pathv1}/?{query}Yes
deleteDcimDeviceBaysId(id, callback)dcim_device-bays_delete{base_path}/{version}/dcim/device-bays/{pathv1}/?{query}Yes
getDcimDeviceRoles(id, name, slug, color, vmRole, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, colorN, colorIc, colorNic, colorIew, colorNiew, colorIsw, colorNisw, colorIe, colorNie, limit, offset, callback)dcim_device-roles_list{base_path}/{version}/dcim/device-roles/?{query}Yes
postDcimDeviceRoles(data, callback)dcim_device-roles_create{base_path}/{version}/dcim/device-roles/?{query}Yes
putDcimDeviceRoles(data, callback)dcim_device-roles_bulk_update{base_path}/{version}/dcim/device-roles/?{query}Yes
patchDcimDeviceRoles(data, callback)dcim_device-roles_bulk_partial_update{base_path}/{version}/dcim/device-roles/?{query}Yes
deleteDcimDeviceRoles(callback)dcim_device-roles_bulk_delete{base_path}/{version}/dcim/device-roles/?{query}Yes
getDcimDeviceRolesId(id, callback)dcim_device-roles_read{base_path}/{version}/dcim/device-roles/{pathv1}/?{query}Yes
putDcimDeviceRolesId(id, data, callback)dcim_device-roles_update{base_path}/{version}/dcim/device-roles/{pathv1}/?{query}Yes
patchDcimDeviceRolesId(id, data, callback)dcim_device-roles_partial_update{base_path}/{version}/dcim/device-roles/{pathv1}/?{query}Yes
deleteDcimDeviceRolesId(id, callback)dcim_device-roles_delete{base_path}/{version}/dcim/device-roles/{pathv1}/?{query}Yes
getDcimDeviceTypes(id, model, slug, partNumber, uHeight, isFullDepth, subdeviceRole, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, manufacturerId, manufacturer, consolePorts, consoleServerPorts, powerPorts, powerOutlets, interfaces, passThroughPorts, deviceBays, tag, idN, idLte, idLt, idGte, idGt, modelN, modelIc, modelNic, modelIew, modelNiew, modelIsw, modelNisw, modelIe, modelNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, partNumberN, partNumberIc, partNumberNic, callback)dcim_device-types_list{base_path}/{version}/dcim/device-types/?{query}Yes
postDcimDeviceTypes(data, callback)dcim_device-types_create{base_path}/{version}/dcim/device-types/?{query}Yes
putDcimDeviceTypes(data, callback)dcim_device-types_bulk_update{base_path}/{version}/dcim/device-types/?{query}Yes
patchDcimDeviceTypes(data, callback)dcim_device-types_bulk_partial_update{base_path}/{version}/dcim/device-types/?{query}Yes
deleteDcimDeviceTypes(callback)dcim_device-types_bulk_delete{base_path}/{version}/dcim/device-types/?{query}Yes
getDcimDeviceTypesId(id, callback)dcim_device-types_read{base_path}/{version}/dcim/device-types/{pathv1}/?{query}Yes
putDcimDeviceTypesId(id, data, callback)dcim_device-types_update{base_path}/{version}/dcim/device-types/{pathv1}/?{query}Yes
patchDcimDeviceTypesId(id, data, callback)dcim_device-types_partial_update{base_path}/{version}/dcim/device-types/{pathv1}/?{query}Yes
deleteDcimDeviceTypesId(id, callback)dcim_device-types_delete{base_path}/{version}/dcim/device-types/{pathv1}/?{query}Yes
getDcimDevices(id, name, assetTag, face, position, vcPosition, vcPriority, tenantGroupId, tenantGroup, tenantId, tenant, localContextData, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, manufacturerId, manufacturer, deviceTypeId, roleId, role, platformId, platform, regionId, region, siteId, site, rackGroupId, rackId, clusterId, model, status, isFullDepth, macAddress, serial, hasPrimaryIp, virtualChassisId, virtualChassisMember, consolePorts, consoleServerPorts, powerPorts, powerOutlets, interfaces, passThroughPorts, deviceBays, tag, idN, callback)dcim_devices_list{base_path}/{version}/dcim/devices/?{query}Yes
postDcimDevices(data, callback)dcim_devices_create{base_path}/{version}/dcim/devices/?{query}Yes
putDcimDevices(data, callback)dcim_devices_bulk_update{base_path}/{version}/dcim/devices/?{query}Yes
patchDcimDevices(data, callback)dcim_devices_bulk_partial_update{base_path}/{version}/dcim/devices/?{query}Yes
deleteDcimDevices(callback)dcim_devices_bulk_delete{base_path}/{version}/dcim/devices/?{query}Yes
getDcimDevicesId(id, callback)dcim_devices_read{base_path}/{version}/dcim/devices/{pathv1}/?{query}Yes
putDcimDevicesId(id, data, callback)dcim_devices_update{base_path}/{version}/dcim/devices/{pathv1}/?{query}Yes
patchDcimDevicesId(id, data, callback)dcim_devices_partial_update{base_path}/{version}/dcim/devices/{pathv1}/?{query}Yes
deleteDcimDevicesId(id, callback)dcim_devices_delete{base_path}/{version}/dcim/devices/{pathv1}/?{query}Yes
getDcimDevicesIdNapalm(id, method, callback)Execute a NAPALM method on a Device{base_path}/{version}/dcim/devices/{pathv1}/napalm/?{query}Yes
getDcimFrontPortTemplates(id, name, type, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, devicetypeIdN, limit, offset, callback)dcim_front-port-templates_list{base_path}/{version}/dcim/front-port-templates/?{query}Yes
postDcimFrontPortTemplates(data, callback)dcim_front-port-templates_create{base_path}/{version}/dcim/front-port-templates/?{query}Yes
putDcimFrontPortTemplates(data, callback)dcim_front-port-templates_bulk_update{base_path}/{version}/dcim/front-port-templates/?{query}Yes
patchDcimFrontPortTemplates(data, callback)dcim_front-port-templates_bulk_partial_update{base_path}/{version}/dcim/front-port-templates/?{query}Yes
deleteDcimFrontPortTemplates(callback)dcim_front-port-templates_bulk_delete{base_path}/{version}/dcim/front-port-templates/?{query}Yes
getDcimFrontPortTemplatesId(id, callback)dcim_front-port-templates_read{base_path}/{version}/dcim/front-port-templates/{pathv1}/?{query}Yes
putDcimFrontPortTemplatesId(id, data, callback)dcim_front-port-templates_update{base_path}/{version}/dcim/front-port-templates/{pathv1}/?{query}Yes
patchDcimFrontPortTemplatesId(id, data, callback)dcim_front-port-templates_partial_update{base_path}/{version}/dcim/front-port-templates/{pathv1}/?{query}Yes
deleteDcimFrontPortTemplatesId(id, callback)dcim_front-port-templates_delete{base_path}/{version}/dcim/front-port-templates/{pathv1}/?{query}Yes
getDcimFrontPorts(id, name, type, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, deviceIdN, deviceN, tagN, limit, offset, callback)dcim_front-ports_list{base_path}/{version}/dcim/front-ports/?{query}Yes
postDcimFrontPorts(data, callback)dcim_front-ports_create{base_path}/{version}/dcim/front-ports/?{query}Yes
putDcimFrontPorts(data, callback)dcim_front-ports_bulk_update{base_path}/{version}/dcim/front-ports/?{query}Yes
patchDcimFrontPorts(data, callback)dcim_front-ports_bulk_partial_update{base_path}/{version}/dcim/front-ports/?{query}Yes
deleteDcimFrontPorts(callback)dcim_front-ports_bulk_delete{base_path}/{version}/dcim/front-ports/?{query}Yes
getDcimFrontPortsId(id, callback)dcim_front-ports_read{base_path}/{version}/dcim/front-ports/{pathv1}/?{query}Yes
putDcimFrontPortsId(id, data, callback)dcim_front-ports_update{base_path}/{version}/dcim/front-ports/{pathv1}/?{query}Yes
patchDcimFrontPortsId(id, data, callback)dcim_front-ports_partial_update{base_path}/{version}/dcim/front-ports/{pathv1}/?{query}Yes
deleteDcimFrontPortsId(id, callback)dcim_front-ports_delete{base_path}/{version}/dcim/front-ports/{pathv1}/?{query}Yes
getDcimFrontPortsIdPaths(id, callback)Return all CablePaths which traverse a given pass-through port.{base_path}/{version}/dcim/front-ports/{pathv1}/paths/?{query}Yes
getDcimInterfaceConnections(site, deviceId, device, limit, offset, callback)dcim_interface-connections_list{base_path}/{version}/dcim/interface-connections/?{query}Yes
getDcimInterfaceTemplates(id, name, type, mgmtOnly, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, devicetypeIdN, limit, offset, callback)dcim_interface-templates_list{base_path}/{version}/dcim/interface-templates/?{query}Yes
postDcimInterfaceTemplates(data, callback)dcim_interface-templates_create{base_path}/{version}/dcim/interface-templates/?{query}Yes
putDcimInterfaceTemplates(data, callback)dcim_interface-templates_bulk_update{base_path}/{version}/dcim/interface-templates/?{query}Yes
patchDcimInterfaceTemplates(data, callback)dcim_interface-templates_bulk_partial_update{base_path}/{version}/dcim/interface-templates/?{query}Yes
deleteDcimInterfaceTemplates(callback)dcim_interface-templates_bulk_delete{base_path}/{version}/dcim/interface-templates/?{query}Yes
getDcimInterfaceTemplatesId(id, callback)dcim_interface-templates_read{base_path}/{version}/dcim/interface-templates/{pathv1}/?{query}Yes
putDcimInterfaceTemplatesId(id, data, callback)dcim_interface-templates_update{base_path}/{version}/dcim/interface-templates/{pathv1}/?{query}Yes
patchDcimInterfaceTemplatesId(id, data, callback)dcim_interface-templates_partial_update{base_path}/{version}/dcim/interface-templates/{pathv1}/?{query}Yes
deleteDcimInterfaceTemplatesId(id, callback)dcim_interface-templates_delete{base_path}/{version}/dcim/interface-templates/{pathv1}/?{query}Yes
getDcimInterfaces(id, name, type, enabled, mtu, mgmtOnly, mode, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, connected, kind, lagId, macAddress, vlanId, vlan, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, mtuN, mtuLte, mtuLt, mtuGte, mtuGt, modeN, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, callback)dcim_interfaces_list{base_path}/{version}/dcim/interfaces/?{query}Yes
postDcimInterfaces(data, callback)dcim_interfaces_create{base_path}/{version}/dcim/interfaces/?{query}Yes
putDcimInterfaces(data, callback)dcim_interfaces_bulk_update{base_path}/{version}/dcim/interfaces/?{query}Yes
patchDcimInterfaces(data, callback)dcim_interfaces_bulk_partial_update{base_path}/{version}/dcim/interfaces/?{query}Yes
deleteDcimInterfaces(callback)dcim_interfaces_bulk_delete{base_path}/{version}/dcim/interfaces/?{query}Yes
getDcimInterfacesId(id, callback)dcim_interfaces_read{base_path}/{version}/dcim/interfaces/{pathv1}/?{query}Yes
putDcimInterfacesId(id, data, callback)dcim_interfaces_update{base_path}/{version}/dcim/interfaces/{pathv1}/?{query}Yes
patchDcimInterfacesId(id, data, callback)dcim_interfaces_partial_update{base_path}/{version}/dcim/interfaces/{pathv1}/?{query}Yes
deleteDcimInterfacesId(id, callback)dcim_interfaces_delete{base_path}/{version}/dcim/interfaces/{pathv1}/?{query}Yes
getDcimInterfacesIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/dcim/interfaces/{pathv1}/trace/?{query}Yes
getDcimInventoryItems(id, name, partId, assetTag, discovered, q, regionId, region, siteId, site, deviceId, device, tag, parentId, manufacturerId, manufacturer, serial, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, partIdN, partIdIc, partIdNic, partIdIew, partIdNiew, partIdIsw, partIdNisw, partIdIe, partIdNie, assetTagN, assetTagIc, assetTagNic, assetTagIew, assetTagNiew, assetTagIsw, assetTagNisw, assetTagIe, assetTagNie, regionIdN, callback)dcim_inventory-items_list{base_path}/{version}/dcim/inventory-items/?{query}Yes
postDcimInventoryItems(data, callback)dcim_inventory-items_create{base_path}/{version}/dcim/inventory-items/?{query}Yes
putDcimInventoryItems(data, callback)dcim_inventory-items_bulk_update{base_path}/{version}/dcim/inventory-items/?{query}Yes
patchDcimInventoryItems(data, callback)dcim_inventory-items_bulk_partial_update{base_path}/{version}/dcim/inventory-items/?{query}Yes
deleteDcimInventoryItems(callback)dcim_inventory-items_bulk_delete{base_path}/{version}/dcim/inventory-items/?{query}Yes
getDcimInventoryItemsId(id, callback)dcim_inventory-items_read{base_path}/{version}/dcim/inventory-items/{pathv1}/?{query}Yes
putDcimInventoryItemsId(id, data, callback)dcim_inventory-items_update{base_path}/{version}/dcim/inventory-items/{pathv1}/?{query}Yes
patchDcimInventoryItemsId(id, data, callback)dcim_inventory-items_partial_update{base_path}/{version}/dcim/inventory-items/{pathv1}/?{query}Yes
deleteDcimInventoryItemsId(id, callback)dcim_inventory-items_delete{base_path}/{version}/dcim/inventory-items/{pathv1}/?{query}Yes
getDcimManufacturers(id, name, slug, description, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, limit, offset, callback)dcim_manufacturers_list{base_path}/{version}/dcim/manufacturers/?{query}Yes
postDcimManufacturers(data, callback)dcim_manufacturers_create{base_path}/{version}/dcim/manufacturers/?{query}Yes
putDcimManufacturers(data, callback)dcim_manufacturers_bulk_update{base_path}/{version}/dcim/manufacturers/?{query}Yes
patchDcimManufacturers(data, callback)dcim_manufacturers_bulk_partial_update{base_path}/{version}/dcim/manufacturers/?{query}Yes
deleteDcimManufacturers(callback)dcim_manufacturers_bulk_delete{base_path}/{version}/dcim/manufacturers/?{query}Yes
getDcimManufacturersId(id, callback)dcim_manufacturers_read{base_path}/{version}/dcim/manufacturers/{pathv1}/?{query}Yes
putDcimManufacturersId(id, data, callback)dcim_manufacturers_update{base_path}/{version}/dcim/manufacturers/{pathv1}/?{query}Yes
patchDcimManufacturersId(id, data, callback)dcim_manufacturers_partial_update{base_path}/{version}/dcim/manufacturers/{pathv1}/?{query}Yes
deleteDcimManufacturersId(id, callback)dcim_manufacturers_delete{base_path}/{version}/dcim/manufacturers/{pathv1}/?{query}Yes
getDcimPlatforms(id, name, slug, napalmDriver, description, q, manufacturerId, manufacturer, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, napalmDriverN, napalmDriverIc, napalmDriverNic, napalmDriverIew, napalmDriverNiew, napalmDriverIsw, napalmDriverNisw, napalmDriverIe, napalmDriverNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, manufacturerIdN, callback)dcim_platforms_list{base_path}/{version}/dcim/platforms/?{query}Yes
postDcimPlatforms(data, callback)dcim_platforms_create{base_path}/{version}/dcim/platforms/?{query}Yes
putDcimPlatforms(data, callback)dcim_platforms_bulk_update{base_path}/{version}/dcim/platforms/?{query}Yes
patchDcimPlatforms(data, callback)dcim_platforms_bulk_partial_update{base_path}/{version}/dcim/platforms/?{query}Yes
deleteDcimPlatforms(callback)dcim_platforms_bulk_delete{base_path}/{version}/dcim/platforms/?{query}Yes
getDcimPlatformsId(id, callback)dcim_platforms_read{base_path}/{version}/dcim/platforms/{pathv1}/?{query}Yes
putDcimPlatformsId(id, data, callback)dcim_platforms_update{base_path}/{version}/dcim/platforms/{pathv1}/?{query}Yes
patchDcimPlatformsId(id, data, callback)dcim_platforms_partial_update{base_path}/{version}/dcim/platforms/{pathv1}/?{query}Yes
deleteDcimPlatformsId(id, callback)dcim_platforms_delete{base_path}/{version}/dcim/platforms/{pathv1}/?{query}Yes
getDcimPowerConnections(name, site, deviceId, device, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, limit, offset, callback)dcim_power-connections_list{base_path}/{version}/dcim/power-connections/?{query}Yes
getDcimPowerFeeds(id, name, status, type, supply, phase, voltage, amperage, maxUtilization, cabled, connected, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, regionId, region, siteId, site, powerPanelId, rackId, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, statusN, typeN, supplyN, phaseN, voltageN, voltageLte, voltageLt, voltageGte, voltageGt, amperageN, amperageLte, callback)dcim_power-feeds_list{base_path}/{version}/dcim/power-feeds/?{query}Yes
postDcimPowerFeeds(data, callback)dcim_power-feeds_create{base_path}/{version}/dcim/power-feeds/?{query}Yes
putDcimPowerFeeds(data, callback)dcim_power-feeds_bulk_update{base_path}/{version}/dcim/power-feeds/?{query}Yes
patchDcimPowerFeeds(data, callback)dcim_power-feeds_bulk_partial_update{base_path}/{version}/dcim/power-feeds/?{query}Yes
deleteDcimPowerFeeds(callback)dcim_power-feeds_bulk_delete{base_path}/{version}/dcim/power-feeds/?{query}Yes
getDcimPowerFeedsId(id, callback)dcim_power-feeds_read{base_path}/{version}/dcim/power-feeds/{pathv1}/?{query}Yes
putDcimPowerFeedsId(id, data, callback)dcim_power-feeds_update{base_path}/{version}/dcim/power-feeds/{pathv1}/?{query}Yes
patchDcimPowerFeedsId(id, data, callback)dcim_power-feeds_partial_update{base_path}/{version}/dcim/power-feeds/{pathv1}/?{query}Yes
deleteDcimPowerFeedsId(id, callback)dcim_power-feeds_delete{base_path}/{version}/dcim/power-feeds/{pathv1}/?{query}Yes
getDcimPowerFeedsIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/dcim/power-feeds/{pathv1}/trace/?{query}Yes
getDcimPowerOutletTemplates(id, name, type, feedLeg, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, feedLegN, devicetypeIdN, limit, offset, callback)dcim_power-outlet-templates_list{base_path}/{version}/dcim/power-outlet-templates/?{query}Yes
postDcimPowerOutletTemplates(data, callback)dcim_power-outlet-templates_create{base_path}/{version}/dcim/power-outlet-templates/?{query}Yes
putDcimPowerOutletTemplates(data, callback)dcim_power-outlet-templates_bulk_update{base_path}/{version}/dcim/power-outlet-templates/?{query}Yes
patchDcimPowerOutletTemplates(data, callback)dcim_power-outlet-templates_bulk_partial_update{base_path}/{version}/dcim/power-outlet-templates/?{query}Yes
deleteDcimPowerOutletTemplates(callback)dcim_power-outlet-templates_bulk_delete{base_path}/{version}/dcim/power-outlet-templates/?{query}Yes
getDcimPowerOutletTemplatesId(id, callback)dcim_power-outlet-templates_read{base_path}/{version}/dcim/power-outlet-templates/{pathv1}/?{query}Yes
putDcimPowerOutletTemplatesId(id, data, callback)dcim_power-outlet-templates_update{base_path}/{version}/dcim/power-outlet-templates/{pathv1}/?{query}Yes
patchDcimPowerOutletTemplatesId(id, data, callback)dcim_power-outlet-templates_partial_update{base_path}/{version}/dcim/power-outlet-templates/{pathv1}/?{query}Yes
deleteDcimPowerOutletTemplatesId(id, callback)dcim_power-outlet-templates_delete{base_path}/{version}/dcim/power-outlet-templates/{pathv1}/?{query}Yes
getDcimPowerOutlets(id, name, feedLeg, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, connected, type, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, feedLegN, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, deviceIdN, deviceN, tagN, typeN, limit, offset, callback)dcim_power-outlets_list{base_path}/{version}/dcim/power-outlets/?{query}Yes
postDcimPowerOutlets(data, callback)dcim_power-outlets_create{base_path}/{version}/dcim/power-outlets/?{query}Yes
putDcimPowerOutlets(data, callback)dcim_power-outlets_bulk_update{base_path}/{version}/dcim/power-outlets/?{query}Yes
patchDcimPowerOutlets(data, callback)dcim_power-outlets_bulk_partial_update{base_path}/{version}/dcim/power-outlets/?{query}Yes
deleteDcimPowerOutlets(callback)dcim_power-outlets_bulk_delete{base_path}/{version}/dcim/power-outlets/?{query}Yes
getDcimPowerOutletsId(id, callback)dcim_power-outlets_read{base_path}/{version}/dcim/power-outlets/{pathv1}/?{query}Yes
putDcimPowerOutletsId(id, data, callback)dcim_power-outlets_update{base_path}/{version}/dcim/power-outlets/{pathv1}/?{query}Yes
patchDcimPowerOutletsId(id, data, callback)dcim_power-outlets_partial_update{base_path}/{version}/dcim/power-outlets/{pathv1}/?{query}Yes
deleteDcimPowerOutletsId(id, callback)dcim_power-outlets_delete{base_path}/{version}/dcim/power-outlets/{pathv1}/?{query}Yes
getDcimPowerOutletsIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/dcim/power-outlets/{pathv1}/trace/?{query}Yes
getDcimPowerPanels(id, name, q, regionId, region, siteId, site, rackGroupId, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, regionIdN, regionN, siteIdN, siteN, rackGroupIdN, tagN, limit, offset, callback)dcim_power-panels_list{base_path}/{version}/dcim/power-panels/?{query}Yes
postDcimPowerPanels(data, callback)dcim_power-panels_create{base_path}/{version}/dcim/power-panels/?{query}Yes
putDcimPowerPanels(data, callback)dcim_power-panels_bulk_update{base_path}/{version}/dcim/power-panels/?{query}Yes
patchDcimPowerPanels(data, callback)dcim_power-panels_bulk_partial_update{base_path}/{version}/dcim/power-panels/?{query}Yes
deleteDcimPowerPanels(callback)dcim_power-panels_bulk_delete{base_path}/{version}/dcim/power-panels/?{query}Yes
getDcimPowerPanelsId(id, callback)dcim_power-panels_read{base_path}/{version}/dcim/power-panels/{pathv1}/?{query}Yes
putDcimPowerPanelsId(id, data, callback)dcim_power-panels_update{base_path}/{version}/dcim/power-panels/{pathv1}/?{query}Yes
patchDcimPowerPanelsId(id, data, callback)dcim_power-panels_partial_update{base_path}/{version}/dcim/power-panels/{pathv1}/?{query}Yes
deleteDcimPowerPanelsId(id, callback)dcim_power-panels_delete{base_path}/{version}/dcim/power-panels/{pathv1}/?{query}Yes
getDcimPowerPortTemplates(id, name, type, maximumDraw, allocatedDraw, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, maximumDrawN, maximumDrawLte, maximumDrawLt, maximumDrawGte, maximumDrawGt, allocatedDrawN, allocatedDrawLte, allocatedDrawLt, allocatedDrawGte, allocatedDrawGt, devicetypeIdN, limit, offset, callback)dcim_power-port-templates_list{base_path}/{version}/dcim/power-port-templates/?{query}Yes
postDcimPowerPortTemplates(data, callback)dcim_power-port-templates_create{base_path}/{version}/dcim/power-port-templates/?{query}Yes
putDcimPowerPortTemplates(data, callback)dcim_power-port-templates_bulk_update{base_path}/{version}/dcim/power-port-templates/?{query}Yes
patchDcimPowerPortTemplates(data, callback)dcim_power-port-templates_bulk_partial_update{base_path}/{version}/dcim/power-port-templates/?{query}Yes
deleteDcimPowerPortTemplates(callback)dcim_power-port-templates_bulk_delete{base_path}/{version}/dcim/power-port-templates/?{query}Yes
getDcimPowerPortTemplatesId(id, callback)dcim_power-port-templates_read{base_path}/{version}/dcim/power-port-templates/{pathv1}/?{query}Yes
putDcimPowerPortTemplatesId(id, data, callback)dcim_power-port-templates_update{base_path}/{version}/dcim/power-port-templates/{pathv1}/?{query}Yes
patchDcimPowerPortTemplatesId(id, data, callback)dcim_power-port-templates_partial_update{base_path}/{version}/dcim/power-port-templates/{pathv1}/?{query}Yes
deleteDcimPowerPortTemplatesId(id, callback)dcim_power-port-templates_delete{base_path}/{version}/dcim/power-port-templates/{pathv1}/?{query}Yes
getDcimPowerPorts(id, name, maximumDraw, allocatedDraw, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, connected, type, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, maximumDrawN, maximumDrawLte, maximumDrawLt, maximumDrawGte, maximumDrawGt, allocatedDrawN, allocatedDrawLte, allocatedDrawLt, allocatedDrawGte, allocatedDrawGt, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, callback)dcim_power-ports_list{base_path}/{version}/dcim/power-ports/?{query}Yes
postDcimPowerPorts(data, callback)dcim_power-ports_create{base_path}/{version}/dcim/power-ports/?{query}Yes
putDcimPowerPorts(data, callback)dcim_power-ports_bulk_update{base_path}/{version}/dcim/power-ports/?{query}Yes
patchDcimPowerPorts(data, callback)dcim_power-ports_bulk_partial_update{base_path}/{version}/dcim/power-ports/?{query}Yes
deleteDcimPowerPorts(callback)dcim_power-ports_bulk_delete{base_path}/{version}/dcim/power-ports/?{query}Yes
getDcimPowerPortsId(id, callback)dcim_power-ports_read{base_path}/{version}/dcim/power-ports/{pathv1}/?{query}Yes
putDcimPowerPortsId(id, data, callback)dcim_power-ports_update{base_path}/{version}/dcim/power-ports/{pathv1}/?{query}Yes
patchDcimPowerPortsId(id, data, callback)dcim_power-ports_partial_update{base_path}/{version}/dcim/power-ports/{pathv1}/?{query}Yes
deleteDcimPowerPortsId(id, callback)dcim_power-ports_delete{base_path}/{version}/dcim/power-ports/{pathv1}/?{query}Yes
getDcimPowerPortsIdTrace(id, callback)Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termin{base_path}/{version}/dcim/power-ports/{pathv1}/trace/?{query}Yes
getDcimRackGroups(id, name, slug, description, q, regionId, region, siteId, site, parentId, parent, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, parentIdN, parentN, limit, callback)dcim_rack-groups_list{base_path}/{version}/dcim/rack-groups/?{query}Yes
postDcimRackGroups(data, callback)dcim_rack-groups_create{base_path}/{version}/dcim/rack-groups/?{query}Yes
putDcimRackGroups(data, callback)dcim_rack-groups_bulk_update{base_path}/{version}/dcim/rack-groups/?{query}Yes
patchDcimRackGroups(data, callback)dcim_rack-groups_bulk_partial_update{base_path}/{version}/dcim/rack-groups/?{query}Yes
deleteDcimRackGroups(callback)dcim_rack-groups_bulk_delete{base_path}/{version}/dcim/rack-groups/?{query}Yes
getDcimRackGroupsId(id, callback)dcim_rack-groups_read{base_path}/{version}/dcim/rack-groups/{pathv1}/?{query}Yes
putDcimRackGroupsId(id, data, callback)dcim_rack-groups_update{base_path}/{version}/dcim/rack-groups/{pathv1}/?{query}Yes
patchDcimRackGroupsId(id, data, callback)dcim_rack-groups_partial_update{base_path}/{version}/dcim/rack-groups/{pathv1}/?{query}Yes
deleteDcimRackGroupsId(id, callback)dcim_rack-groups_delete{base_path}/{version}/dcim/rack-groups/{pathv1}/?{query}Yes
getDcimRackReservations(id, created, tenantGroupId, tenantGroup, tenantId, tenant, q, rackId, siteId, site, groupId, group, userId, user, tag, idN, idLte, idLt, idGte, idGt, createdN, createdLte, createdLt, createdGte, createdGt, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, rackIdN, siteIdN, siteN, groupIdN, groupN, userIdN, userN, tagN, limit, offset, callback)dcim_rack-reservations_list{base_path}/{version}/dcim/rack-reservations/?{query}Yes
postDcimRackReservations(data, callback)dcim_rack-reservations_create{base_path}/{version}/dcim/rack-reservations/?{query}Yes
putDcimRackReservations(data, callback)dcim_rack-reservations_bulk_update{base_path}/{version}/dcim/rack-reservations/?{query}Yes
patchDcimRackReservations(data, callback)dcim_rack-reservations_bulk_partial_update{base_path}/{version}/dcim/rack-reservations/?{query}Yes
deleteDcimRackReservations(callback)dcim_rack-reservations_bulk_delete{base_path}/{version}/dcim/rack-reservations/?{query}Yes
getDcimRackReservationsId(id, callback)dcim_rack-reservations_read{base_path}/{version}/dcim/rack-reservations/{pathv1}/?{query}Yes
putDcimRackReservationsId(id, data, callback)dcim_rack-reservations_update{base_path}/{version}/dcim/rack-reservations/{pathv1}/?{query}Yes
patchDcimRackReservationsId(id, data, callback)dcim_rack-reservations_partial_update{base_path}/{version}/dcim/rack-reservations/{pathv1}/?{query}Yes
deleteDcimRackReservationsId(id, callback)dcim_rack-reservations_delete{base_path}/{version}/dcim/rack-reservations/{pathv1}/?{query}Yes
getDcimRackRoles(id, name, slug, color, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, colorN, colorIc, colorNic, colorIew, colorNiew, colorIsw, colorNisw, colorIe, colorNie, limit, offset, callback)dcim_rack-roles_list{base_path}/{version}/dcim/rack-roles/?{query}Yes
postDcimRackRoles(data, callback)dcim_rack-roles_create{base_path}/{version}/dcim/rack-roles/?{query}Yes
putDcimRackRoles(data, callback)dcim_rack-roles_bulk_update{base_path}/{version}/dcim/rack-roles/?{query}Yes
patchDcimRackRoles(data, callback)dcim_rack-roles_bulk_partial_update{base_path}/{version}/dcim/rack-roles/?{query}Yes
deleteDcimRackRoles(callback)dcim_rack-roles_bulk_delete{base_path}/{version}/dcim/rack-roles/?{query}Yes
getDcimRackRolesId(id, callback)dcim_rack-roles_read{base_path}/{version}/dcim/rack-roles/{pathv1}/?{query}Yes
putDcimRackRolesId(id, data, callback)dcim_rack-roles_update{base_path}/{version}/dcim/rack-roles/{pathv1}/?{query}Yes
patchDcimRackRolesId(id, data, callback)dcim_rack-roles_partial_update{base_path}/{version}/dcim/rack-roles/{pathv1}/?{query}Yes
deleteDcimRackRolesId(id, callback)dcim_rack-roles_delete{base_path}/{version}/dcim/rack-roles/{pathv1}/?{query}Yes
getDcimRacks(id, name, facilityId, assetTag, uHeight, descUnits, outerWidth, outerDepth, outerUnit, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, regionId, region, siteId, site, groupId, group, status, type, width, roleId, role, serial, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, facilityIdN, facilityIdIc, facilityIdNic, callback)dcim_racks_list{base_path}/{version}/dcim/racks/?{query}Yes
postDcimRacks(data, callback)dcim_racks_create{base_path}/{version}/dcim/racks/?{query}Yes
putDcimRacks(data, callback)dcim_racks_bulk_update{base_path}/{version}/dcim/racks/?{query}Yes
patchDcimRacks(data, callback)dcim_racks_bulk_partial_update{base_path}/{version}/dcim/racks/?{query}Yes
deleteDcimRacks(callback)dcim_racks_bulk_delete{base_path}/{version}/dcim/racks/?{query}Yes
getDcimRacksId(id, callback)dcim_racks_read{base_path}/{version}/dcim/racks/{pathv1}/?{query}Yes
putDcimRacksId(id, data, callback)dcim_racks_update{base_path}/{version}/dcim/racks/{pathv1}/?{query}Yes
patchDcimRacksId(id, data, callback)dcim_racks_partial_update{base_path}/{version}/dcim/racks/{pathv1}/?{query}Yes
deleteDcimRacksId(id, callback)dcim_racks_delete{base_path}/{version}/dcim/racks/{pathv1}/?{query}Yes
getDcimRacksIdElevation(id, q, face = 'front', render = 'json', unitWidth, unitHeight, legendWidth, exclude, expandDevices, includeImages, callback)Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.{base_path}/{version}/dcim/racks/{pathv1}/elevation/?{query}Yes
getDcimRearPortTemplates(id, name, type, positions, q, devicetypeId, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, positionsN, positionsLte, positionsLt, positionsGte, positionsGt, devicetypeIdN, limit, offset, callback)dcim_rear-port-templates_list{base_path}/{version}/dcim/rear-port-templates/?{query}Yes
postDcimRearPortTemplates(data, callback)dcim_rear-port-templates_create{base_path}/{version}/dcim/rear-port-templates/?{query}Yes
putDcimRearPortTemplates(data, callback)dcim_rear-port-templates_bulk_update{base_path}/{version}/dcim/rear-port-templates/?{query}Yes
patchDcimRearPortTemplates(data, callback)dcim_rear-port-templates_bulk_partial_update{base_path}/{version}/dcim/rear-port-templates/?{query}Yes
deleteDcimRearPortTemplates(callback)dcim_rear-port-templates_bulk_delete{base_path}/{version}/dcim/rear-port-templates/?{query}Yes
getDcimRearPortTemplatesId(id, callback)dcim_rear-port-templates_read{base_path}/{version}/dcim/rear-port-templates/{pathv1}/?{query}Yes
putDcimRearPortTemplatesId(id, data, callback)dcim_rear-port-templates_update{base_path}/{version}/dcim/rear-port-templates/{pathv1}/?{query}Yes
patchDcimRearPortTemplatesId(id, data, callback)dcim_rear-port-templates_partial_update{base_path}/{version}/dcim/rear-port-templates/{pathv1}/?{query}Yes
deleteDcimRearPortTemplatesId(id, callback)dcim_rear-port-templates_delete{base_path}/{version}/dcim/rear-port-templates/{pathv1}/?{query}Yes
getDcimRearPorts(id, name, type, positions, description, q, regionId, region, siteId, site, deviceId, device, tag, cabled, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, typeN, positionsN, positionsLte, positionsLt, positionsGte, positionsGt, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, deviceIdN, deviceN, tagN, callback)dcim_rear-ports_list{base_path}/{version}/dcim/rear-ports/?{query}Yes
postDcimRearPorts(data, callback)dcim_rear-ports_create{base_path}/{version}/dcim/rear-ports/?{query}Yes
putDcimRearPorts(data, callback)dcim_rear-ports_bulk_update{base_path}/{version}/dcim/rear-ports/?{query}Yes
patchDcimRearPorts(data, callback)dcim_rear-ports_bulk_partial_update{base_path}/{version}/dcim/rear-ports/?{query}Yes
deleteDcimRearPorts(callback)dcim_rear-ports_bulk_delete{base_path}/{version}/dcim/rear-ports/?{query}Yes
getDcimRearPortsId(id, callback)dcim_rear-ports_read{base_path}/{version}/dcim/rear-ports/{pathv1}/?{query}Yes
putDcimRearPortsId(id, data, callback)dcim_rear-ports_update{base_path}/{version}/dcim/rear-ports/{pathv1}/?{query}Yes
patchDcimRearPortsId(id, data, callback)dcim_rear-ports_partial_update{base_path}/{version}/dcim/rear-ports/{pathv1}/?{query}Yes
deleteDcimRearPortsId(id, callback)dcim_rear-ports_delete{base_path}/{version}/dcim/rear-ports/{pathv1}/?{query}Yes
getDcimRearPortsIdPaths(id, callback)Return all CablePaths which traverse a given pass-through port.{base_path}/{version}/dcim/rear-ports/{pathv1}/paths/?{query}Yes
getDcimRegions(id, name, slug, description, q, parentId, parent, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, parentIdN, parentN, limit, offset, callback)dcim_regions_list{base_path}/{version}/dcim/regions/?{query}Yes
postDcimRegions(data, callback)dcim_regions_create{base_path}/{version}/dcim/regions/?{query}Yes
putDcimRegions(data, callback)dcim_regions_bulk_update{base_path}/{version}/dcim/regions/?{query}Yes
patchDcimRegions(data, callback)dcim_regions_bulk_partial_update{base_path}/{version}/dcim/regions/?{query}Yes
deleteDcimRegions(callback)dcim_regions_bulk_delete{base_path}/{version}/dcim/regions/?{query}Yes
getDcimRegionsId(id, callback)dcim_regions_read{base_path}/{version}/dcim/regions/{pathv1}/?{query}Yes
putDcimRegionsId(id, data, callback)dcim_regions_update{base_path}/{version}/dcim/regions/{pathv1}/?{query}Yes
patchDcimRegionsId(id, data, callback)dcim_regions_partial_update{base_path}/{version}/dcim/regions/{pathv1}/?{query}Yes
deleteDcimRegionsId(id, callback)dcim_regions_delete{base_path}/{version}/dcim/regions/{pathv1}/?{query}Yes
getDcimSites(id, name, slug, facility, asn, latitude, longitude, contactName, contactPhone, contactEmail, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, status, regionId, region, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, facilityN, facilityIc, callback)dcim_sites_list{base_path}/{version}/dcim/sites/?{query}Yes
postDcimSites(data, callback)dcim_sites_create{base_path}/{version}/dcim/sites/?{query}Yes
putDcimSites(data, callback)dcim_sites_bulk_update{base_path}/{version}/dcim/sites/?{query}Yes
patchDcimSites(data, callback)dcim_sites_bulk_partial_update{base_path}/{version}/dcim/sites/?{query}Yes
deleteDcimSites(callback)dcim_sites_bulk_delete{base_path}/{version}/dcim/sites/?{query}Yes
getDcimSitesId(id, callback)dcim_sites_read{base_path}/{version}/dcim/sites/{pathv1}/?{query}Yes
putDcimSitesId(id, data, callback)dcim_sites_update{base_path}/{version}/dcim/sites/{pathv1}/?{query}Yes
patchDcimSitesId(id, data, callback)dcim_sites_partial_update{base_path}/{version}/dcim/sites/{pathv1}/?{query}Yes
deleteDcimSitesId(id, callback)dcim_sites_delete{base_path}/{version}/dcim/sites/{pathv1}/?{query}Yes
getDcimVirtualChassis(id, domain, name, q, masterId, master, regionId, region, siteId, site, tenantId, tenant, tag, idN, idLte, idLt, idGte, idGt, domainN, domainIc, domainNic, domainIew, domainNiew, domainIsw, domainNisw, domainIe, domainNie, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, masterIdN, masterN, regionIdN, regionN, siteIdN, siteN, tenantIdN, tenantN, tagN, limit, offset, callback)dcim_virtual-chassis_list{base_path}/{version}/dcim/virtual-chassis/?{query}Yes
postDcimVirtualChassis(data, callback)dcim_virtual-chassis_create{base_path}/{version}/dcim/virtual-chassis/?{query}Yes
putDcimVirtualChassis(data, callback)dcim_virtual-chassis_bulk_update{base_path}/{version}/dcim/virtual-chassis/?{query}Yes
patchDcimVirtualChassis(data, callback)dcim_virtual-chassis_bulk_partial_update{base_path}/{version}/dcim/virtual-chassis/?{query}Yes
deleteDcimVirtualChassis(callback)dcim_virtual-chassis_bulk_delete{base_path}/{version}/dcim/virtual-chassis/?{query}Yes
getDcimVirtualChassisId(id, callback)dcim_virtual-chassis_read{base_path}/{version}/dcim/virtual-chassis/{pathv1}/?{query}Yes
putDcimVirtualChassisId(id, data, callback)dcim_virtual-chassis_update{base_path}/{version}/dcim/virtual-chassis/{pathv1}/?{query}Yes
patchDcimVirtualChassisId(id, data, callback)dcim_virtual-chassis_partial_update{base_path}/{version}/dcim/virtual-chassis/{pathv1}/?{query}Yes
deleteDcimVirtualChassisId(id, callback)dcim_virtual-chassis_delete{base_path}/{version}/dcim/virtual-chassis/{pathv1}/?{query}Yes
getExtrasConfigContexts(id, name, isActive, q, regionId, region, siteId, site, roleId, role, platformId, platform, clusterGroupId, clusterGroup, clusterId, tenantGroupId, tenantGroup, tenantId, tenant, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, regionIdN, regionN, siteIdN, siteN, roleIdN, roleN, platformIdN, platformN, clusterGroupIdN, clusterGroupN, clusterIdN, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, tagN, callback)extras_config-contexts_list{base_path}/{version}/extras/config-contexts/?{query}Yes
postExtrasConfigContexts(data, callback)extras_config-contexts_create{base_path}/{version}/extras/config-contexts/?{query}Yes
putExtrasConfigContexts(data, callback)extras_config-contexts_bulk_update{base_path}/{version}/extras/config-contexts/?{query}Yes
patchExtrasConfigContexts(data, callback)extras_config-contexts_bulk_partial_update{base_path}/{version}/extras/config-contexts/?{query}Yes
deleteExtrasConfigContexts(callback)extras_config-contexts_bulk_delete{base_path}/{version}/extras/config-contexts/?{query}Yes
getExtrasConfigContextsId(id, callback)extras_config-contexts_read{base_path}/{version}/extras/config-contexts/{pathv1}/?{query}Yes
putExtrasConfigContextsId(id, data, callback)extras_config-contexts_update{base_path}/{version}/extras/config-contexts/{pathv1}/?{query}Yes
patchExtrasConfigContextsId(id, data, callback)extras_config-contexts_partial_update{base_path}/{version}/extras/config-contexts/{pathv1}/?{query}Yes
deleteExtrasConfigContextsId(id, callback)extras_config-contexts_delete{base_path}/{version}/extras/config-contexts/{pathv1}/?{query}Yes
getExtrasContentTypes(id, appLabel, model, limit, offset, callback)Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.{base_path}/{version}/extras/content-types/?{query}Yes
getExtrasContentTypesId(id, callback)Read-only list of ContentTypes. Limit results to ContentTypes pertinent to NetBox objects.{base_path}/{version}/extras/content-types/{pathv1}/?{query}Yes
getExtrasCustomFields(id, contentTypes, name, required, filterLogic, weight, limit, offset, callback)extras_custom-fields_list{base_path}/{version}/extras/custom-fields/?{query}Yes
postExtrasCustomFields(data, callback)extras_custom-fields_create{base_path}/{version}/extras/custom-fields/?{query}Yes
putExtrasCustomFields(data, callback)extras_custom-fields_bulk_update{base_path}/{version}/extras/custom-fields/?{query}Yes
patchExtrasCustomFields(data, callback)extras_custom-fields_bulk_partial_update{base_path}/{version}/extras/custom-fields/?{query}Yes
deleteExtrasCustomFields(callback)extras_custom-fields_bulk_delete{base_path}/{version}/extras/custom-fields/?{query}Yes
getExtrasCustomFieldsId(id, callback)extras_custom-fields_read{base_path}/{version}/extras/custom-fields/{pathv1}/?{query}Yes
putExtrasCustomFieldsId(id, data, callback)extras_custom-fields_update{base_path}/{version}/extras/custom-fields/{pathv1}/?{query}Yes
patchExtrasCustomFieldsId(id, data, callback)extras_custom-fields_partial_update{base_path}/{version}/extras/custom-fields/{pathv1}/?{query}Yes
deleteExtrasCustomFieldsId(id, callback)extras_custom-fields_delete{base_path}/{version}/extras/custom-fields/{pathv1}/?{query}Yes
getExtrasExportTemplates(id, contentType, name, idN, idLte, idLt, idGte, idGt, contentTypeN, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, limit, offset, callback)extras_export-templates_list{base_path}/{version}/extras/export-templates/?{query}Yes
postExtrasExportTemplates(data, callback)extras_export-templates_create{base_path}/{version}/extras/export-templates/?{query}Yes
putExtrasExportTemplates(data, callback)extras_export-templates_bulk_update{base_path}/{version}/extras/export-templates/?{query}Yes
patchExtrasExportTemplates(data, callback)extras_export-templates_bulk_partial_update{base_path}/{version}/extras/export-templates/?{query}Yes
deleteExtrasExportTemplates(callback)extras_export-templates_bulk_delete{base_path}/{version}/extras/export-templates/?{query}Yes
getExtrasExportTemplatesId(id, callback)extras_export-templates_read{base_path}/{version}/extras/export-templates/{pathv1}/?{query}Yes
putExtrasExportTemplatesId(id, data, callback)extras_export-templates_update{base_path}/{version}/extras/export-templates/{pathv1}/?{query}Yes
patchExtrasExportTemplatesId(id, data, callback)extras_export-templates_partial_update{base_path}/{version}/extras/export-templates/{pathv1}/?{query}Yes
deleteExtrasExportTemplatesId(id, callback)extras_export-templates_delete{base_path}/{version}/extras/export-templates/{pathv1}/?{query}Yes
getExtrasImageAttachments(id, contentTypeId, objectId, name, contentType, idN, idLte, idLt, idGte, idGt, contentTypeIdN, objectIdN, objectIdLte, objectIdLt, objectIdGte, objectIdGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, contentTypeN, limit, offset, callback)extras_image-attachments_list{base_path}/{version}/extras/image-attachments/?{query}Yes
postExtrasImageAttachments(data, callback)extras_image-attachments_create{base_path}/{version}/extras/image-attachments/?{query}Yes
putExtrasImageAttachments(data, callback)extras_image-attachments_bulk_update{base_path}/{version}/extras/image-attachments/?{query}Yes
patchExtrasImageAttachments(data, callback)extras_image-attachments_bulk_partial_update{base_path}/{version}/extras/image-attachments/?{query}Yes
deleteExtrasImageAttachments(callback)extras_image-attachments_bulk_delete{base_path}/{version}/extras/image-attachments/?{query}Yes
getExtrasImageAttachmentsId(id, callback)extras_image-attachments_read{base_path}/{version}/extras/image-attachments/{pathv1}/?{query}Yes
putExtrasImageAttachmentsId(id, data, callback)extras_image-attachments_update{base_path}/{version}/extras/image-attachments/{pathv1}/?{query}Yes
patchExtrasImageAttachmentsId(id, data, callback)extras_image-attachments_partial_update{base_path}/{version}/extras/image-attachments/{pathv1}/?{query}Yes
deleteExtrasImageAttachmentsId(id, callback)extras_image-attachments_delete{base_path}/{version}/extras/image-attachments/{pathv1}/?{query}Yes
getExtrasJobResults(id, created, completed, status, user, objType, name, q, idN, idLte, idLt, idGte, idGt, statusN, userN, objTypeN, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, limit, offset, callback)Retrieve a list of job results{base_path}/{version}/extras/job-results/?{query}Yes
getExtrasJobResultsId(id, callback)Retrieve a list of job results{base_path}/{version}/extras/job-results/{pathv1}/?{query}Yes
getExtrasObjectChanges(id, user, userName, requestId, action, changedObjectTypeId, changedObjectId, objectRepr, q, time, changedObjectType, userId, idN, idLte, idLt, idGte, idGt, userN, userNameN, userNameIc, userNameNic, userNameIew, userNameNiew, userNameIsw, userNameNisw, userNameIe, userNameNie, actionN, changedObjectTypeIdN, changedObjectIdN, changedObjectIdLte, changedObjectIdLt, changedObjectIdGte, changedObjectIdGt, objectReprN, objectReprIc, objectReprNic, objectReprIew, objectReprNiew, objectReprIsw, objectReprNisw, objectReprIe, objectReprNie, changedObjectTypeN, userIdN, limit, offset, callback)Retrieve a list of recent changes.{base_path}/{version}/extras/object-changes/?{query}Yes
getExtrasObjectChangesId(id, callback)Retrieve a list of recent changes.{base_path}/{version}/extras/object-changes/{pathv1}/?{query}Yes
getExtrasReports(callback)Compile all reports and their related results (if any). Result data is deferred in the list view.{base_path}/{version}/extras/reports/?{query}Yes
getExtrasReportsId(id, callback)Retrieve a single Report identified as " . ".{base_path}/{version}/extras/reports/{pathv1}/?{query}Yes
postExtrasReportsIdRun(id, callback)Run a Report identified as " . " and return the pending JobResult as the result{base_path}/{version}/extras/reports/{pathv1}/run/?{query}Yes
getExtrasScripts(callback)extras_scripts_list{base_path}/{version}/extras/scripts/?{query}Yes
getExtrasScriptsId(id, callback)extras_scripts_read{base_path}/{version}/extras/scripts/{pathv1}/?{query}Yes
getExtrasTags(id, name, slug, color, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, colorN, colorIc, colorNic, colorIew, colorNiew, colorIsw, colorNisw, colorIe, colorNie, limit, offset, callback)extras_tags_list{base_path}/{version}/extras/tags/?{query}Yes
postExtrasTags(data, callback)extras_tags_create{base_path}/{version}/extras/tags/?{query}Yes
putExtrasTags(data, callback)extras_tags_bulk_update{base_path}/{version}/extras/tags/?{query}Yes
patchExtrasTags(data, callback)extras_tags_bulk_partial_update{base_path}/{version}/extras/tags/?{query}Yes
deleteExtrasTags(callback)extras_tags_bulk_delete{base_path}/{version}/extras/tags/?{query}Yes
getExtrasTagsId(id, callback)extras_tags_read{base_path}/{version}/extras/tags/{pathv1}/?{query}Yes
putExtrasTagsId(id, data, callback)extras_tags_update{base_path}/{version}/extras/tags/{pathv1}/?{query}Yes
patchExtrasTagsId(id, data, callback)extras_tags_partial_update{base_path}/{version}/extras/tags/{pathv1}/?{query}Yes
deleteExtrasTagsId(id, callback)extras_tags_delete{base_path}/{version}/extras/tags/{pathv1}/?{query}Yes
getIpamAggregates(id, dateAdded, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, family, prefix, rirId, rir, tag, idN, idLte, idLt, idGte, idGt, dateAddedN, dateAddedLte, dateAddedLt, dateAddedGte, dateAddedGt, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, rirIdN, rirN, tagN, limit, offset, callback)ipam_aggregates_list{base_path}/{version}/ipam/aggregates/?{query}Yes
postIpamAggregates(data, callback)ipam_aggregates_create{base_path}/{version}/ipam/aggregates/?{query}Yes
putIpamAggregates(data, callback)ipam_aggregates_bulk_update{base_path}/{version}/ipam/aggregates/?{query}Yes
patchIpamAggregates(data, callback)ipam_aggregates_bulk_partial_update{base_path}/{version}/ipam/aggregates/?{query}Yes
deleteIpamAggregates(callback)ipam_aggregates_bulk_delete{base_path}/{version}/ipam/aggregates/?{query}Yes
getIpamAggregatesId(id, callback)ipam_aggregates_read{base_path}/{version}/ipam/aggregates/{pathv1}/?{query}Yes
putIpamAggregatesId(id, data, callback)ipam_aggregates_update{base_path}/{version}/ipam/aggregates/{pathv1}/?{query}Yes
patchIpamAggregatesId(id, data, callback)ipam_aggregates_partial_update{base_path}/{version}/ipam/aggregates/{pathv1}/?{query}Yes
deleteIpamAggregatesId(id, callback)ipam_aggregates_delete{base_path}/{version}/ipam/aggregates/{pathv1}/?{query}Yes
getIpamIpAddresses(id, dnsName, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, family, parent, address, maskLength, vrfId, vrf, presentInVrfId, presentInVrf, device, deviceId, virtualMachine, virtualMachineId, interfaceParam, interfaceId, vminterface, vminterfaceId, assignedToInterface, status, role, tag, idN, idLte, idLt, idGte, idGt, dnsNameN, dnsNameIc, dnsNameNic, dnsNameIew, dnsNameNiew, dnsNameIsw, dnsNameNisw, dnsNameIe, dnsNameNie, tenantGroupIdN, tenantGroupN, tenantIdN, callback)ipam_ip-addresses_list{base_path}/{version}/ipam/ip-addresses/?{query}Yes
postIpamIpAddresses(data, callback)ipam_ip-addresses_create{base_path}/{version}/ipam/ip-addresses/?{query}Yes
putIpamIpAddresses(data, callback)ipam_ip-addresses_bulk_update{base_path}/{version}/ipam/ip-addresses/?{query}Yes
patchIpamIpAddresses(data, callback)ipam_ip-addresses_bulk_partial_update{base_path}/{version}/ipam/ip-addresses/?{query}Yes
deleteIpamIpAddresses(callback)ipam_ip-addresses_bulk_delete{base_path}/{version}/ipam/ip-addresses/?{query}Yes
getIpamIpAddressesId(id, callback)ipam_ip-addresses_read{base_path}/{version}/ipam/ip-addresses/{pathv1}/?{query}Yes
putIpamIpAddressesId(id, data, callback)ipam_ip-addresses_update{base_path}/{version}/ipam/ip-addresses/{pathv1}/?{query}Yes
patchIpamIpAddressesId(id, data, callback)ipam_ip-addresses_partial_update{base_path}/{version}/ipam/ip-addresses/{pathv1}/?{query}Yes
deleteIpamIpAddressesId(id, callback)ipam_ip-addresses_delete{base_path}/{version}/ipam/ip-addresses/{pathv1}/?{query}Yes
getIpamPrefixes(id, isPool, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, family, prefix, within, withinInclude, contains, maskLength, maskLengthGte, maskLengthLte, vrfId, vrf, presentInVrfId, presentInVrf, regionId, region, siteId, site, vlanId, vlanVid, roleId, role, status, tag, idN, idLte, idLt, idGte, idGt, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, vrfIdN, vrfN, regionIdN, regionN, siteIdN, siteN, callback)ipam_prefixes_list{base_path}/{version}/ipam/prefixes/?{query}Yes
postIpamPrefixes(data, callback)ipam_prefixes_create{base_path}/{version}/ipam/prefixes/?{query}Yes
putIpamPrefixes(data, callback)ipam_prefixes_bulk_update{base_path}/{version}/ipam/prefixes/?{query}Yes
patchIpamPrefixes(data, callback)ipam_prefixes_bulk_partial_update{base_path}/{version}/ipam/prefixes/?{query}Yes
deleteIpamPrefixes(callback)ipam_prefixes_bulk_delete{base_path}/{version}/ipam/prefixes/?{query}Yes
getIpamPrefixesId(id, callback)ipam_prefixes_read{base_path}/{version}/ipam/prefixes/{pathv1}/?{query}Yes
putIpamPrefixesId(id, data, callback)ipam_prefixes_update{base_path}/{version}/ipam/prefixes/{pathv1}/?{query}Yes
patchIpamPrefixesId(id, data, callback)ipam_prefixes_partial_update{base_path}/{version}/ipam/prefixes/{pathv1}/?{query}Yes
deleteIpamPrefixesId(id, callback)ipam_prefixes_delete{base_path}/{version}/ipam/prefixes/{pathv1}/?{query}Yes
getIpamPrefixesIdAvailableIps(id, callback)A convenience method for returning available IP addresses within a prefix. By default, the number o{base_path}/{version}/ipam/prefixes/{pathv1}/available-ips/?{query}Yes
postIpamPrefixesIdAvailableIps(id, data, callback)A convenience method for returning available IP addresses within a prefix. By default, the number o{base_path}/{version}/ipam/prefixes/{pathv1}/available-ips/?{query}Yes
getIpamPrefixesIdAvailablePrefixes(id, callback)A convenience method for returning available child prefixes within a parent.{base_path}/{version}/ipam/prefixes/{pathv1}/available-prefixes/?{query}Yes
postIpamPrefixesIdAvailablePrefixes(id, data, callback)A convenience method for returning available child prefixes within a parent.{base_path}/{version}/ipam/prefixes/{pathv1}/available-prefixes/?{query}Yes
getIpamRirs(id, name, slug, isPrivate, description, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, limit, offset, callback)ipam_rirs_list{base_path}/{version}/ipam/rirs/?{query}Yes
postIpamRirs(data, callback)ipam_rirs_create{base_path}/{version}/ipam/rirs/?{query}Yes
putIpamRirs(data, callback)ipam_rirs_bulk_update{base_path}/{version}/ipam/rirs/?{query}Yes
patchIpamRirs(data, callback)ipam_rirs_bulk_partial_update{base_path}/{version}/ipam/rirs/?{query}Yes
deleteIpamRirs(callback)ipam_rirs_bulk_delete{base_path}/{version}/ipam/rirs/?{query}Yes
getIpamRirsId(id, callback)ipam_rirs_read{base_path}/{version}/ipam/rirs/{pathv1}/?{query}Yes
putIpamRirsId(id, data, callback)ipam_rirs_update{base_path}/{version}/ipam/rirs/{pathv1}/?{query}Yes
patchIpamRirsId(id, data, callback)ipam_rirs_partial_update{base_path}/{version}/ipam/rirs/{pathv1}/?{query}Yes
deleteIpamRirsId(id, callback)ipam_rirs_delete{base_path}/{version}/ipam/rirs/{pathv1}/?{query}Yes
getIpamRoles(id, name, slug, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, limit, offset, callback)ipam_roles_list{base_path}/{version}/ipam/roles/?{query}Yes
postIpamRoles(data, callback)ipam_roles_create{base_path}/{version}/ipam/roles/?{query}Yes
putIpamRoles(data, callback)ipam_roles_bulk_update{base_path}/{version}/ipam/roles/?{query}Yes
patchIpamRoles(data, callback)ipam_roles_bulk_partial_update{base_path}/{version}/ipam/roles/?{query}Yes
deleteIpamRoles(callback)ipam_roles_bulk_delete{base_path}/{version}/ipam/roles/?{query}Yes
getIpamRolesId(id, callback)ipam_roles_read{base_path}/{version}/ipam/roles/{pathv1}/?{query}Yes
putIpamRolesId(id, data, callback)ipam_roles_update{base_path}/{version}/ipam/roles/{pathv1}/?{query}Yes
patchIpamRolesId(id, data, callback)ipam_roles_partial_update{base_path}/{version}/ipam/roles/{pathv1}/?{query}Yes
deleteIpamRolesId(id, callback)ipam_roles_delete{base_path}/{version}/ipam/roles/{pathv1}/?{query}Yes
getIpamRouteTargets(id, name, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, importingVrfId, importingVrf, exportingVrfId, exportingVrf, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, importingVrfIdN, importingVrfN, exportingVrfIdN, exportingVrfN, tagN, limit, offset, callback)ipam_route-targets_list{base_path}/{version}/ipam/route-targets/?{query}Yes
postIpamRouteTargets(data, callback)ipam_route-targets_create{base_path}/{version}/ipam/route-targets/?{query}Yes
putIpamRouteTargets(data, callback)ipam_route-targets_bulk_update{base_path}/{version}/ipam/route-targets/?{query}Yes
patchIpamRouteTargets(data, callback)ipam_route-targets_bulk_partial_update{base_path}/{version}/ipam/route-targets/?{query}Yes
deleteIpamRouteTargets(callback)ipam_route-targets_bulk_delete{base_path}/{version}/ipam/route-targets/?{query}Yes
getIpamRouteTargetsId(id, callback)ipam_route-targets_read{base_path}/{version}/ipam/route-targets/{pathv1}/?{query}Yes
putIpamRouteTargetsId(id, data, callback)ipam_route-targets_update{base_path}/{version}/ipam/route-targets/{pathv1}/?{query}Yes
patchIpamRouteTargetsId(id, data, callback)ipam_route-targets_partial_update{base_path}/{version}/ipam/route-targets/{pathv1}/?{query}Yes
deleteIpamRouteTargetsId(id, callback)ipam_route-targets_delete{base_path}/{version}/ipam/route-targets/{pathv1}/?{query}Yes
getIpamServices(id, name, protocol, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, deviceId, device, virtualMachineId, virtualMachine, port, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, protocolN, deviceIdN, deviceN, virtualMachineIdN, virtualMachineN, tagN, limit, offset, callback)ipam_services_list{base_path}/{version}/ipam/services/?{query}Yes
postIpamServices(data, callback)ipam_services_create{base_path}/{version}/ipam/services/?{query}Yes
putIpamServices(data, callback)ipam_services_bulk_update{base_path}/{version}/ipam/services/?{query}Yes
patchIpamServices(data, callback)ipam_services_bulk_partial_update{base_path}/{version}/ipam/services/?{query}Yes
deleteIpamServices(callback)ipam_services_bulk_delete{base_path}/{version}/ipam/services/?{query}Yes
getIpamServicesId(id, callback)ipam_services_read{base_path}/{version}/ipam/services/{pathv1}/?{query}Yes
putIpamServicesId(id, data, callback)ipam_services_update{base_path}/{version}/ipam/services/{pathv1}/?{query}Yes
patchIpamServicesId(id, data, callback)ipam_services_partial_update{base_path}/{version}/ipam/services/{pathv1}/?{query}Yes
deleteIpamServicesId(id, callback)ipam_services_delete{base_path}/{version}/ipam/services/{pathv1}/?{query}Yes
getIpamVlanGroups(id, name, slug, description, q, regionId, region, siteId, site, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, regionIdN, regionN, siteIdN, siteN, limit, offset, callback)ipam_vlan-groups_list{base_path}/{version}/ipam/vlan-groups/?{query}Yes
postIpamVlanGroups(data, callback)ipam_vlan-groups_create{base_path}/{version}/ipam/vlan-groups/?{query}Yes
putIpamVlanGroups(data, callback)ipam_vlan-groups_bulk_update{base_path}/{version}/ipam/vlan-groups/?{query}Yes
patchIpamVlanGroups(data, callback)ipam_vlan-groups_bulk_partial_update{base_path}/{version}/ipam/vlan-groups/?{query}Yes
deleteIpamVlanGroups(callback)ipam_vlan-groups_bulk_delete{base_path}/{version}/ipam/vlan-groups/?{query}Yes
getIpamVlanGroupsId(id, callback)ipam_vlan-groups_read{base_path}/{version}/ipam/vlan-groups/{pathv1}/?{query}Yes
putIpamVlanGroupsId(id, data, callback)ipam_vlan-groups_update{base_path}/{version}/ipam/vlan-groups/{pathv1}/?{query}Yes
patchIpamVlanGroupsId(id, data, callback)ipam_vlan-groups_partial_update{base_path}/{version}/ipam/vlan-groups/{pathv1}/?{query}Yes
deleteIpamVlanGroupsId(id, callback)ipam_vlan-groups_delete{base_path}/{version}/ipam/vlan-groups/{pathv1}/?{query}Yes
getIpamVlans(id, vid, name, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, regionId, region, siteId, site, groupId, group, roleId, role, status, tag, idN, idLte, idLt, idGte, idGt, vidN, vidLte, vidLt, vidGte, vidGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, regionIdN, regionN, siteIdN, callback)ipam_vlans_list{base_path}/{version}/ipam/vlans/?{query}Yes
postIpamVlans(data, callback)ipam_vlans_create{base_path}/{version}/ipam/vlans/?{query}Yes
putIpamVlans(data, callback)ipam_vlans_bulk_update{base_path}/{version}/ipam/vlans/?{query}Yes
patchIpamVlans(data, callback)ipam_vlans_bulk_partial_update{base_path}/{version}/ipam/vlans/?{query}Yes
deleteIpamVlans(callback)ipam_vlans_bulk_delete{base_path}/{version}/ipam/vlans/?{query}Yes
getIpamVlansId(id, callback)ipam_vlans_read{base_path}/{version}/ipam/vlans/{pathv1}/?{query}Yes
putIpamVlansId(id, data, callback)ipam_vlans_update{base_path}/{version}/ipam/vlans/{pathv1}/?{query}Yes
patchIpamVlansId(id, data, callback)ipam_vlans_partial_update{base_path}/{version}/ipam/vlans/{pathv1}/?{query}Yes
deleteIpamVlansId(id, callback)ipam_vlans_delete{base_path}/{version}/ipam/vlans/{pathv1}/?{query}Yes
getIpamVrfs(id, name, rd, enforceUnique, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, importTargetId, importTarget, exportTargetId, exportTarget, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, rdN, rdIc, rdNic, rdIew, rdNiew, rdIsw, rdNisw, rdIe, rdNie, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, importTargetIdN, importTargetN, exportTargetIdN, callback)ipam_vrfs_list{base_path}/{version}/ipam/vrfs/?{query}Yes
postIpamVrfs(data, callback)ipam_vrfs_create{base_path}/{version}/ipam/vrfs/?{query}Yes
putIpamVrfs(data, callback)ipam_vrfs_bulk_update{base_path}/{version}/ipam/vrfs/?{query}Yes
patchIpamVrfs(data, callback)ipam_vrfs_bulk_partial_update{base_path}/{version}/ipam/vrfs/?{query}Yes
deleteIpamVrfs(callback)ipam_vrfs_bulk_delete{base_path}/{version}/ipam/vrfs/?{query}Yes
getIpamVrfsId(id, callback)ipam_vrfs_read{base_path}/{version}/ipam/vrfs/{pathv1}/?{query}Yes
putIpamVrfsId(id, data, callback)ipam_vrfs_update{base_path}/{version}/ipam/vrfs/{pathv1}/?{query}Yes
patchIpamVrfsId(id, data, callback)ipam_vrfs_partial_update{base_path}/{version}/ipam/vrfs/{pathv1}/?{query}Yes
deleteIpamVrfsId(id, callback)ipam_vrfs_delete{base_path}/{version}/ipam/vrfs/{pathv1}/?{query}Yes
getSecretsGenerateRsaKeyPair(callback)This endpoint can be used to generate a new RSA key pair. The keys are returned in PEM format.{base_path}/{version}/secrets/generate-rsa-key-pair/?{query}Yes
postSecretsGetSessionKey(callback)Retrieve a temporary session key to use for encrypting and decrypting secrets via the API. The user{base_path}/{version}/secrets/get-session-key/?{query}Yes
getSecretsSecretRoles(id, name, slug, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, limit, offset, callback)secrets_secret-roles_list{base_path}/{version}/secrets/secret-roles/?{query}Yes
postSecretsSecretRoles(data, callback)secrets_secret-roles_create{base_path}/{version}/secrets/secret-roles/?{query}Yes
putSecretsSecretRoles(data, callback)secrets_secret-roles_bulk_update{base_path}/{version}/secrets/secret-roles/?{query}Yes
patchSecretsSecretRoles(data, callback)secrets_secret-roles_bulk_partial_update{base_path}/{version}/secrets/secret-roles/?{query}Yes
deleteSecretsSecretRoles(callback)secrets_secret-roles_bulk_delete{base_path}/{version}/secrets/secret-roles/?{query}Yes
getSecretsSecretRolesId(id, callback)secrets_secret-roles_read{base_path}/{version}/secrets/secret-roles/{pathv1}/?{query}Yes
putSecretsSecretRolesId(id, data, callback)secrets_secret-roles_update{base_path}/{version}/secrets/secret-roles/{pathv1}/?{query}Yes
patchSecretsSecretRolesId(id, data, callback)secrets_secret-roles_partial_update{base_path}/{version}/secrets/secret-roles/{pathv1}/?{query}Yes
deleteSecretsSecretRolesId(id, callback)secrets_secret-roles_delete{base_path}/{version}/secrets/secret-roles/{pathv1}/?{query}Yes
getSecretsSecrets(id, name, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, roleId, role, device, deviceId, virtualMachine, virtualMachineId, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, roleIdN, roleN, deviceN, deviceIdN, virtualMachineN, virtualMachineIdN, tagN, limit, offset, callback)secrets_secrets_list{base_path}/{version}/secrets/secrets/?{query}Yes
postSecretsSecrets(data, callback)secrets_secrets_create{base_path}/{version}/secrets/secrets/?{query}Yes
putSecretsSecrets(data, callback)secrets_secrets_bulk_update{base_path}/{version}/secrets/secrets/?{query}Yes
patchSecretsSecrets(data, callback)secrets_secrets_bulk_partial_update{base_path}/{version}/secrets/secrets/?{query}Yes
deleteSecretsSecrets(callback)secrets_secrets_bulk_delete{base_path}/{version}/secrets/secrets/?{query}Yes
getSecretsSecretsId(id, callback)secrets_secrets_read{base_path}/{version}/secrets/secrets/{pathv1}/?{query}Yes
putSecretsSecretsId(id, data, callback)secrets_secrets_update{base_path}/{version}/secrets/secrets/{pathv1}/?{query}Yes
patchSecretsSecretsId(id, data, callback)secrets_secrets_partial_update{base_path}/{version}/secrets/secrets/{pathv1}/?{query}Yes
deleteSecretsSecretsId(id, callback)secrets_secrets_delete{base_path}/{version}/secrets/secrets/{pathv1}/?{query}Yes
getStatus(callback)A lightweight read-only endpoint for conveying NetBox's current operational status.{base_path}/{version}/status/?{query}Yes
getGraphql(body, callback)A lightweight read-only endpoint for conveying querying using graphql./graphql/?{query}Yes
getTenancyTenantGroups(id, name, slug, description, q, parentId, parent, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, parentIdN, parentN, limit, offset, callback)tenancy_tenant-groups_list{base_path}/{version}/tenancy/tenant-groups/?{query}Yes
postTenancyTenantGroups(data, callback)tenancy_tenant-groups_create{base_path}/{version}/tenancy/tenant-groups/?{query}Yes
putTenancyTenantGroups(data, callback)tenancy_tenant-groups_bulk_update{base_path}/{version}/tenancy/tenant-groups/?{query}Yes
patchTenancyTenantGroups(data, callback)tenancy_tenant-groups_bulk_partial_update{base_path}/{version}/tenancy/tenant-groups/?{query}Yes
deleteTenancyTenantGroups(callback)tenancy_tenant-groups_bulk_delete{base_path}/{version}/tenancy/tenant-groups/?{query}Yes
getTenancyTenantGroupsId(id, callback)tenancy_tenant-groups_read{base_path}/{version}/tenancy/tenant-groups/{pathv1}/?{query}Yes
putTenancyTenantGroupsId(id, data, callback)tenancy_tenant-groups_update{base_path}/{version}/tenancy/tenant-groups/{pathv1}/?{query}Yes
patchTenancyTenantGroupsId(id, data, callback)tenancy_tenant-groups_partial_update{base_path}/{version}/tenancy/tenant-groups/{pathv1}/?{query}Yes
deleteTenancyTenantGroupsId(id, callback)tenancy_tenant-groups_delete{base_path}/{version}/tenancy/tenant-groups/{pathv1}/?{query}Yes
getTenancyTenants(id, name, slug, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, groupId, group, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, groupIdN, groupN, tagN, limit, offset, callback)tenancy_tenants_list{base_path}/{version}/tenancy/tenants/?{query}Yes
postTenancyTenants(data, callback)tenancy_tenants_create{base_path}/{version}/tenancy/tenants/?{query}Yes
putTenancyTenants(data, callback)tenancy_tenants_bulk_update{base_path}/{version}/tenancy/tenants/?{query}Yes
patchTenancyTenants(data, callback)tenancy_tenants_bulk_partial_update{base_path}/{version}/tenancy/tenants/?{query}Yes
deleteTenancyTenants(callback)tenancy_tenants_bulk_delete{base_path}/{version}/tenancy/tenants/?{query}Yes
getTenancyTenantsId(id, callback)tenancy_tenants_read{base_path}/{version}/tenancy/tenants/{pathv1}/?{query}Yes
putTenancyTenantsId(id, data, callback)tenancy_tenants_update{base_path}/{version}/tenancy/tenants/{pathv1}/?{query}Yes
patchTenancyTenantsId(id, data, callback)tenancy_tenants_partial_update{base_path}/{version}/tenancy/tenants/{pathv1}/?{query}Yes
deleteTenancyTenantsId(id, callback)tenancy_tenants_delete{base_path}/{version}/tenancy/tenants/{pathv1}/?{query}Yes
getUsersConfig(callback)Return the UserConfig for the currently authenticated User.{base_path}/{version}/users/config/?{query}Yes
getUsersGroups(id, name, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, limit, offset, callback)users_groups_list{base_path}/{version}/users/groups/?{query}Yes
postUsersGroups(data, callback)users_groups_create{base_path}/{version}/users/groups/?{query}Yes
putUsersGroups(data, callback)users_groups_bulk_update{base_path}/{version}/users/groups/?{query}Yes
patchUsersGroups(data, callback)users_groups_bulk_partial_update{base_path}/{version}/users/groups/?{query}Yes
deleteUsersGroups(callback)users_groups_bulk_delete{base_path}/{version}/users/groups/?{query}Yes
getUsersGroupsId(id, callback)users_groups_read{base_path}/{version}/users/groups/{pathv1}/?{query}Yes
putUsersGroupsId(id, data, callback)users_groups_update{base_path}/{version}/users/groups/{pathv1}/?{query}Yes
patchUsersGroupsId(id, data, callback)users_groups_partial_update{base_path}/{version}/users/groups/{pathv1}/?{query}Yes
deleteUsersGroupsId(id, callback)users_groups_delete{base_path}/{version}/users/groups/{pathv1}/?{query}Yes
getUsersPermissions(id, name, enabled, objectTypes, userId, user, groupId, group, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, objectTypesN, userIdN, userN, groupIdN, groupN, limit, offset, callback)users_permissions_list{base_path}/{version}/users/permissions/?{query}Yes
postUsersPermissions(data, callback)users_permissions_create{base_path}/{version}/users/permissions/?{query}Yes
putUsersPermissions(data, callback)users_permissions_bulk_update{base_path}/{version}/users/permissions/?{query}Yes
patchUsersPermissions(data, callback)users_permissions_bulk_partial_update{base_path}/{version}/users/permissions/?{query}Yes
deleteUsersPermissions(callback)users_permissions_bulk_delete{base_path}/{version}/users/permissions/?{query}Yes
getUsersPermissionsId(id, callback)users_permissions_read{base_path}/{version}/users/permissions/{pathv1}/?{query}Yes
putUsersPermissionsId(id, data, callback)users_permissions_update{base_path}/{version}/users/permissions/{pathv1}/?{query}Yes
patchUsersPermissionsId(id, data, callback)users_permissions_partial_update{base_path}/{version}/users/permissions/{pathv1}/?{query}Yes
deleteUsersPermissionsId(id, callback)users_permissions_delete{base_path}/{version}/users/permissions/{pathv1}/?{query}Yes
getUsersUsers(id, username, firstName, lastName, email, isStaff, isActive, q, groupId, group, idN, idLte, idLt, idGte, idGt, usernameN, usernameIc, usernameNic, usernameIew, usernameNiew, usernameIsw, usernameNisw, usernameIe, usernameNie, firstNameN, firstNameIc, firstNameNic, firstNameIew, firstNameNiew, firstNameIsw, firstNameNisw, firstNameIe, firstNameNie, lastNameN, lastNameIc, lastNameNic, lastNameIew, lastNameNiew, lastNameIsw, lastNameNisw, lastNameIe, lastNameNie, emailN, emailIc, emailNic, emailIew, emailNiew, emailIsw, emailNisw, emailIe, callback)users_users_list{base_path}/{version}/users/users/?{query}Yes
postUsersUsers(data, callback)users_users_create{base_path}/{version}/users/users/?{query}Yes
putUsersUsers(data, callback)users_users_bulk_update{base_path}/{version}/users/users/?{query}Yes
patchUsersUsers(data, callback)users_users_bulk_partial_update{base_path}/{version}/users/users/?{query}Yes
deleteUsersUsers(callback)users_users_bulk_delete{base_path}/{version}/users/users/?{query}Yes
getUsersUsersId(id, callback)users_users_read{base_path}/{version}/users/users/{pathv1}/?{query}Yes
putUsersUsersId(id, data, callback)users_users_update{base_path}/{version}/users/users/{pathv1}/?{query}Yes
patchUsersUsersId(id, data, callback)users_users_partial_update{base_path}/{version}/users/users/{pathv1}/?{query}Yes
deleteUsersUsersId(id, callback)users_users_delete{base_path}/{version}/users/users/{pathv1}/?{query}Yes
getVirtualizationClusterGroups(id, name, slug, description, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, limit, offset, callback)virtualization_cluster-groups_list{base_path}/{version}/virtualization/cluster-groups/?{query}Yes
postVirtualizationClusterGroups(data, callback)virtualization_cluster-groups_create{base_path}/{version}/virtualization/cluster-groups/?{query}Yes
putVirtualizationClusterGroups(data, callback)virtualization_cluster-groups_bulk_update{base_path}/{version}/virtualization/cluster-groups/?{query}Yes
patchVirtualizationClusterGroups(data, callback)virtualization_cluster-groups_bulk_partial_update{base_path}/{version}/virtualization/cluster-groups/?{query}Yes
deleteVirtualizationClusterGroups(callback)virtualization_cluster-groups_bulk_delete{base_path}/{version}/virtualization/cluster-groups/?{query}Yes
getVirtualizationClusterGroupsId(id, callback)virtualization_cluster-groups_read{base_path}/{version}/virtualization/cluster-groups/{pathv1}/?{query}Yes
putVirtualizationClusterGroupsId(id, data, callback)virtualization_cluster-groups_update{base_path}/{version}/virtualization/cluster-groups/{pathv1}/?{query}Yes
patchVirtualizationClusterGroupsId(id, data, callback)virtualization_cluster-groups_partial_update{base_path}/{version}/virtualization/cluster-groups/{pathv1}/?{query}Yes
deleteVirtualizationClusterGroupsId(id, callback)virtualization_cluster-groups_delete{base_path}/{version}/virtualization/cluster-groups/{pathv1}/?{query}Yes
getVirtualizationClusterTypes(id, name, slug, description, q, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, slugN, slugIc, slugNic, slugIew, slugNiew, slugIsw, slugNisw, slugIe, slugNie, descriptionN, descriptionIc, descriptionNic, descriptionIew, descriptionNiew, descriptionIsw, descriptionNisw, descriptionIe, descriptionNie, limit, offset, callback)virtualization_cluster-types_list{base_path}/{version}/virtualization/cluster-types/?{query}Yes
postVirtualizationClusterTypes(data, callback)virtualization_cluster-types_create{base_path}/{version}/virtualization/cluster-types/?{query}Yes
putVirtualizationClusterTypes(data, callback)virtualization_cluster-types_bulk_update{base_path}/{version}/virtualization/cluster-types/?{query}Yes
patchVirtualizationClusterTypes(data, callback)virtualization_cluster-types_bulk_partial_update{base_path}/{version}/virtualization/cluster-types/?{query}Yes
deleteVirtualizationClusterTypes(callback)virtualization_cluster-types_bulk_delete{base_path}/{version}/virtualization/cluster-types/?{query}Yes
getVirtualizationClusterTypesId(id, callback)virtualization_cluster-types_read{base_path}/{version}/virtualization/cluster-types/{pathv1}/?{query}Yes
putVirtualizationClusterTypesId(id, data, callback)virtualization_cluster-types_update{base_path}/{version}/virtualization/cluster-types/{pathv1}/?{query}Yes
patchVirtualizationClusterTypesId(id, data, callback)virtualization_cluster-types_partial_update{base_path}/{version}/virtualization/cluster-types/{pathv1}/?{query}Yes
deleteVirtualizationClusterTypesId(id, callback)virtualization_cluster-types_delete{base_path}/{version}/virtualization/cluster-types/{pathv1}/?{query}Yes
getVirtualizationClusters(id, name, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, regionId, region, siteId, site, groupId, group, typeId, type, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, tenantGroupIdN, tenantGroupN, tenantIdN, tenantN, regionIdN, regionN, siteIdN, siteN, groupIdN, groupN, typeIdN, typeN, tagN, limit, callback)virtualization_clusters_list{base_path}/{version}/virtualization/clusters/?{query}Yes
postVirtualizationClusters(data, callback)virtualization_clusters_create{base_path}/{version}/virtualization/clusters/?{query}Yes
putVirtualizationClusters(data, callback)virtualization_clusters_bulk_update{base_path}/{version}/virtualization/clusters/?{query}Yes
patchVirtualizationClusters(data, callback)virtualization_clusters_bulk_partial_update{base_path}/{version}/virtualization/clusters/?{query}Yes
deleteVirtualizationClusters(callback)virtualization_clusters_bulk_delete{base_path}/{version}/virtualization/clusters/?{query}Yes
getVirtualizationClustersId(id, callback)virtualization_clusters_read{base_path}/{version}/virtualization/clusters/{pathv1}/?{query}Yes
putVirtualizationClustersId(id, data, callback)virtualization_clusters_update{base_path}/{version}/virtualization/clusters/{pathv1}/?{query}Yes
patchVirtualizationClustersId(id, data, callback)virtualization_clusters_partial_update{base_path}/{version}/virtualization/clusters/{pathv1}/?{query}Yes
deleteVirtualizationClustersId(id, callback)virtualization_clusters_delete{base_path}/{version}/virtualization/clusters/{pathv1}/?{query}Yes
getVirtualizationInterfaces(id, name, enabled, mtu, q, clusterId, cluster, virtualMachineId, virtualMachine, macAddress, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, mtuN, mtuLte, mtuLt, mtuGte, mtuGt, clusterIdN, clusterN, virtualMachineIdN, virtualMachineN, macAddressN, macAddressIc, macAddressNic, macAddressIew, macAddressNiew, macAddressIsw, macAddressNisw, macAddressIe, macAddressNie, tagN, limit, offset, callback)virtualization_interfaces_list{base_path}/{version}/virtualization/interfaces/?{query}Yes
postVirtualizationInterfaces(data, callback)virtualization_interfaces_create{base_path}/{version}/virtualization/interfaces/?{query}Yes
putVirtualizationInterfaces(data, callback)virtualization_interfaces_bulk_update{base_path}/{version}/virtualization/interfaces/?{query}Yes
patchVirtualizationInterfaces(data, callback)virtualization_interfaces_bulk_partial_update{base_path}/{version}/virtualization/interfaces/?{query}Yes
deleteVirtualizationInterfaces(callback)virtualization_interfaces_bulk_delete{base_path}/{version}/virtualization/interfaces/?{query}Yes
getVirtualizationInterfacesId(id, callback)virtualization_interfaces_read{base_path}/{version}/virtualization/interfaces/{pathv1}/?{query}Yes
putVirtualizationInterfacesId(id, data, callback)virtualization_interfaces_update{base_path}/{version}/virtualization/interfaces/{pathv1}/?{query}Yes
patchVirtualizationInterfacesId(id, data, callback)virtualization_interfaces_partial_update{base_path}/{version}/virtualization/interfaces/{pathv1}/?{query}Yes
deleteVirtualizationInterfacesId(id, callback)virtualization_interfaces_delete{base_path}/{version}/virtualization/interfaces/{pathv1}/?{query}Yes
getVirtualizationVirtualMachines(id, name, cluster, vcpus, memory, disk, localContextData, tenantGroupId, tenantGroup, tenantId, tenant, created, createdGte, createdLte, lastUpdated, lastUpdatedGte, lastUpdatedLte, q, status, clusterGroupId, clusterGroup, clusterTypeId, clusterType, clusterId, regionId, region, siteId, site, roleId, role, platformId, platform, macAddress, hasPrimaryIp, tag, idN, idLte, idLt, idGte, idGt, nameN, nameIc, nameNic, nameIew, nameNiew, nameIsw, nameNisw, nameIe, nameNie, clusterN, callback)virtualization_virtual-machines_list{base_path}/{version}/virtualization/virtual-machines/?{query}Yes
postVirtualizationVirtualMachines(data, callback)virtualization_virtual-machines_create{base_path}/{version}/virtualization/virtual-machines/?{query}Yes
putVirtualizationVirtualMachines(data, callback)virtualization_virtual-machines_bulk_update{base_path}/{version}/virtualization/virtual-machines/?{query}Yes
patchVirtualizationVirtualMachines(data, callback)virtualization_virtual-machines_bulk_partial_update{base_path}/{version}/virtualization/virtual-machines/?{query}Yes
deleteVirtualizationVirtualMachines(callback)virtualization_virtual-machines_bulk_delete{base_path}/{version}/virtualization/virtual-machines/?{query}Yes
getVirtualizationVirtualMachinesId(id, callback)virtualization_virtual-machines_read{base_path}/{version}/virtualization/virtual-machines/{pathv1}/?{query}Yes
putVirtualizationVirtualMachinesId(id, data, callback)virtualization_virtual-machines_update{base_path}/{version}/virtualization/virtual-machines/{pathv1}/?{query}Yes
patchVirtualizationVirtualMachinesId(id, data, callback)virtualization_virtual-machines_partial_update{base_path}/{version}/virtualization/virtual-machines/{pathv1}/?{query}Yes
deleteVirtualizationVirtualMachinesId(id, callback)virtualization_virtual-machines_delete{base_path}/{version}/virtualization/virtual-machines/{pathv1}/?{query}Yes

Authentication

This document will go through the steps for authenticating the Netbox_v210 adapter with Basic Authentication. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.

Basic Authentication

The Netbox_v210 adapter requires Basic Authentication. If you change authentication methods, you should change this section accordingly and merge it back into the adapter repository.

STEPS

  1. Ensure you have access to a Netbox_v210 server and that it is running
  2. Follow the steps in the README.md to import the adapter into IAP if you have not already done so
  3. Use the properties below for the properties.authentication field
    "authentication": {
    "auth_method": "basic user_password",
    "username": "<username>",
    "password": "<password>",
    "token": "",
    "token_timeout": 1800000,
    "token_cache": "local",
    "invalid_token_error": 401,
    "auth_field": "header.headers.Authorization",
    "auth_field_format": "Basic {b64}{username}:{password}{/b64}",
    "auth_logging": false,
    "client_id": "",
    "client_secret": "",
    "grant_type": ""
    }
  4. Restart the adapter. If your properties were set correctly, the adapter should go online.

Troubleshooting

  • Make sure you copied over the correct username and password.
  • Turn on debug level logs for the adapter in IAP Admin Essentials.
  • Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
  • Investigate the logs - in particular:
    • The FULL REQUEST log to make sure the proper headers are being sent with the request.
    • The FULL BODY log to make sure the payload is accurate.
    • The CALL RETURN log to see what the other system is telling us.
  • Remember when you are done to turn auth_logging off as you do not want to log credentials.

Additional Information

Enhancements

Adding a Second Instance of an Adapter

You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.

Adding Adapter Calls

There are multiple ways to add calls to an existing adapter.

The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute npm run adapter:update.

mv updatePackage.zip adapter-netbox_v210
cd adapter-netbox_v210
npm run adapter:update

If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.

If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on our Documentation Site.

Files to update
* entities/<entity>/action.json: add an action
* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
* adapter.js: add the new method and make sure it calls the proper entity and action
* pronghorn.json: add the new method
* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test

Adding Adapter Properties

While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.

Files to update
* propertiesSchema.json: add the new property and how it is defined
* sampleProperties: add the new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Changing Adapter Authentication

Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.

Files to update
* entities/.system/action.json: change the getToken action as needed
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
* propertiesSchema.json: add any new property and how it is defined
* sampleProperties: add any new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties

Enhancing Adapter Integration Tests

The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.

Files to update
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.

As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on our Documentation Site.

Contributing

First off, thanks for taking the time to contribute!

The following is a set of rules for contributing.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.

How to Contribute

Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]

Helpful Links

Adapter Technical Resources

Node Scripts

There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.

RunDescription
npm run adapter:installProvides an easier way to install the adapter.
npm run adapter:checkMigrateChecks whether your adapter can and should be migrated to the latest foundation.
npm run adapter:findPathCan be used to see if the adapter supports a particular API call.
npm run adapter:migrateProvides an easier way to update your adapter after you download the migration zip from Itential DevSite.
npm run adapter:updateProvides an easier way to update your adapter after you download the update zip from Itential DevSite.
npm run adapter:revertAllows you to revert after a migration or update if it resulted in issues.
npm run troubleshootProvides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get.
npm run connectivityProvides a connectivity check to the Servicenow system.
npm run healthcheckChecks whether the configured healthcheck call works to Servicenow.
npm run basicgetChecks whether the basic get calls works to Servicenow.

Troubleshoot

Run npm run troubleshoot to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.

You also have the option to run individual commands to perform specific test:

  • npm run healthcheck will perform a healthcheck request of with current setting.
  • npm run basicget will perform some non-parameter GET request with current setting.
  • npm run connectivity will perform networking diagnostics of the adatper endpoint.

Connectivity Issues

  1. You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
npm run troubleshoot
  1. Verify the adapter properties are set up correctly.
Go into the Itential Platform GUI and verify/update the properties
  1. Verify there is connectivity between the Itential Platform Server and Netbox_v210 Server.
ping the ip address of Netbox_v210 server
try telnet to the ip address port of Netbox_v210
execute a curl command to the other system
  1. Verify the credentials provided for Netbox_v210.
login to Netbox_v210 using the provided credentials
  1. Verify the API of the call utilized for Netbox_v210 Healthcheck.
Go into the Itential Platform GUI and verify/update the properties

Functional Issues

Adapter logs are located in /var/log/pronghorn. In older releases of the Itential Platform, there is a pronghorn.log file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.