Skip to content

umich-vci/gobam2

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
Sorry, we had to truncate this directory to 1,000 files. 2 entries were omitted from the list.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Go API client for gobam2

The BlueCat Address Manager 9.5 RESTful v2 API is a new RESTful API for Address Manager that presents Address Manager objects as resources. Each resource has a unique endpoint, and related resources are grouped in collections. To fetch an individual resource, a GET request is sent to the resource's endpoint. To fetch all resources in a collection, a GET request is sent to the collection's endpoint.

The RESTful v2 API is hypermedia driven and uses the HAL format for representing links. When navigating through the API, you can use those links to navigate to related resources or child resources of the requested endpoint. The API supports the following media types for most endpoints: application/hal+json, application/json, and text/csv. For authentication, the API supports both Basic and Bearer HTTP authentication schemes.

To get started, create a session and receive credentials for Basic authentication by sending a POST request to the /sessions endpoint, with a message body containing the user's credentials:

{\"username\":\"apiuser\", \"password\":\"apipass\"}

The response will contain an apiToken field that can be entered with the username in the Swagger UI Authorize dialog. The response will also contain a basicAuthenticationCredentials field containing a base64 encoding of the requester's username and API token delimited by a colon. This string can be injected directly into request Authorization headers in the following format:

Authorization: Basic YXBpOlQ0OExOT3VIRGhDcnVBNEo1bGFES3JuS3hTZC9QK3pjczZXTzBJMDY=

For full details on API format and authentication methods, refer to the Address Manager RESTful v2 API Guide on the BlueCat Documentation Portal.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 9.5.0
  • Package version: 1.0.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://care.bluecatnetworks.com/

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import gobam2 "github.com/umich-vci/gobam2"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value gobam2.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), gobam2.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value gobam2.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), gobam2.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using gobam2.ContextOperationServerIndices and gobam2.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), gobam2.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), gobam2.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
ACLResourcesAPI DeleteAccessControlList Delete /api/v2/accessControlLists/{id} Delete an access control list
ACLResourcesAPI GetAccessControlList Get /api/v2/accessControlLists/{id} Retrieve a single access control list
ACLResourcesAPI GetAccessControlLists Get /api/v2/accessControlLists Retrieve a collection of access control lists
ACLResourcesAPI GetConfigurationAccessControlLists Get /api/v2/configurations/{collectionId}/accessControlLists Retrieve a collection of access control lists
ACLResourcesAPI PostConfigurationAccessControlList Post /api/v2/configurations/{collectionId}/accessControlLists Create a new access control list
ACLResourcesAPI PutAccessControlList Put /api/v2/accessControlLists/{id} Update an access control list
AdminResourcesAPI DeleteAccessRight Delete /api/v2/accessRights/{id} Delete an access right
AdminResourcesAPI DeleteAuthenticator Delete /api/v2/authenticators/{id} Delete an authenticator
AdminResourcesAPI DeleteCollectionUserDefinedLink Delete /api/v2/{collection}/{collectionId}/userDefinedLinks/{id} Delete a user-defined link
AdminResourcesAPI DeleteGroup Delete /api/v2/groups/{id} Delete a group
AdminResourcesAPI DeleteGroupUser Delete /api/v2/groups/{collectionId}/users/{id} Unlink a user from a group
AdminResourcesAPI DeleteImport Delete /api/v2/imports/{id} Delete an import resource
AdminResourcesAPI DeleteResponsePolicyImport Delete /api/v2/responsePolicies/{collectionId}/imports/{id} Delete a response policy item import resource
AdminResourcesAPI DeleteSigningPolicy Delete /api/v2/signingPolicies/{id} Delete a signing policy
AdminResourcesAPI DeleteTrustRelationship Delete /api/v2/trustRelationships/{id} Delete a trust relationship
AdminResourcesAPI DeleteUser Delete /api/v2/users/{id} Delete a user
AdminResourcesAPI DeleteUserDefinedFieldDefinition Delete /api/v2/userDefinedFieldDefinitions/{id} Delete a user-defined field definition
AdminResourcesAPI DeleteUserDefinedLinkDefinition Delete /api/v2/userDefinedLinkDefinitions/{id} Delete a user-defined link definition
AdminResourcesAPI DeleteUserGroup Delete /api/v2/users/{collectionId}/groups/{id} Unlink a group from a user
AdminResourcesAPI DeleteWorkflowRequest Delete /api/v2/workflowRequests/{id} Delete a workflow request
AdminResourcesAPI GetAccessRight Get /api/v2/accessRights/{id} Retrieve a single access right
AdminResourcesAPI GetAccessRights Get /api/v2/accessRights Retrieve a collection of access rights
AdminResourcesAPI GetAuthenticator Get /api/v2/authenticators/{id} Retrieve a single authenticator
AdminResourcesAPI GetAuthenticators Get /api/v2/authenticators Retrieve a collection of authenticators
AdminResourcesAPI GetCollectionAccessRights Get /api/v2/{collection}/{collectionId}/accessRights Retrieve a collection of access rights
AdminResourcesAPI GetCollectionTransactions Get /api/v2/{collection}/{collectionId}/transactions Retrieve a collection of transactions
AdminResourcesAPI GetCollectionUserDefinedLink Get /api/v2/{collection}/{collectionId}/userDefinedLinks/{id} Retrieve a single user-defined link
AdminResourcesAPI GetCollectionUserDefinedLinks Get /api/v2/{collection}/{collectionId}/userDefinedLinks Retrieve a collection of user-defined links
AdminResourcesAPI GetCollectionWorkflowRequests Get /api/v2/{collection}/{collectionId}/workflowRequests Retrieve a collection of workflow requests
AdminResourcesAPI GetDatabase Get /api/v2/databases/{id} Retrieve a single database resource
AdminResourcesAPI GetDatabases Get /api/v2/databases Retrieve a collection of database resources
AdminResourcesAPI GetEvent Get /api/v2/events/{id} Retrieve a single event
AdminResourcesAPI GetEvents Get /api/v2/events Retrieve a collection of events
AdminResourcesAPI GetGroup Get /api/v2/groups/{id} Retrieve a single group
AdminResourcesAPI GetGroupUser Get /api/v2/groups/{collectionId}/users/{id} Retrieve a single linked user
AdminResourcesAPI GetGroupUsers Get /api/v2/groups/{collectionId}/users Retrieve a collection of linked users
AdminResourcesAPI GetGroups Get /api/v2/groups Retrieve a collection of groups
AdminResourcesAPI GetImport Get /api/v2/imports/{id} Retrieve a single resource import
AdminResourcesAPI GetImportLog Get /api/v2/imports/{collectionId}/logs/{id} Retrieve a log resource
AdminResourcesAPI GetImportLogs Get /api/v2/imports/{collectionId}/logs Retrieve a collection of log resources
AdminResourcesAPI GetImports Get /api/v2/imports Retrieve a collection of resource imports
AdminResourcesAPI GetResources Get /api/v2 Retrieve a collection of resources
AdminResourcesAPI GetResponsePolicyImport Get /api/v2/responsePolicies/{collectionId}/imports/{id} Retrieve a single response policy item import
AdminResourcesAPI GetResponsePolicyImports Get /api/v2/responsePolicies/{collectionId}/imports Retrieve a collection of response policy item imports
AdminResourcesAPI GetRoot Get /api/v2/{id} Retrieve the root resource
AdminResourcesAPI GetSession Get /api/v2/sessions/{id} Retrieve a single session
AdminResourcesAPI GetSessionCurrent Get /api/v2/sessions/current Retrieve the current session
AdminResourcesAPI GetSessions Get /api/v2/sessions Retrieve a collection of sessions
AdminResourcesAPI GetSetting Get /api/v2/settings/{id} Retrieve a single settings resource
AdminResourcesAPI GetSettings Get /api/v2/settings Retrieve a collection of settings resources
AdminResourcesAPI GetSigningPolicies Get /api/v2/signingPolicies Retrieve a collection of signing policies
AdminResourcesAPI GetSigningPolicy Get /api/v2/signingPolicies/{id} Retrieve a single signing policy
AdminResourcesAPI GetTransaction Get /api/v2/transactions/{id} Retrieve a single transaction
AdminResourcesAPI GetTransactionOperation Get /api/v2/transactions/{collectionId}/operations/{id} Retrieve a single operation
AdminResourcesAPI GetTransactionOperations Get /api/v2/transactions/{collectionId}/operations Retrieve a collection of operations
AdminResourcesAPI GetTransactions Get /api/v2/transactions Retrieve a collection of transactions
AdminResourcesAPI GetTrustRelationship Get /api/v2/trustRelationships/{id} Retrieve a single trust relationship
AdminResourcesAPI GetTrustRelationships Get /api/v2/trustRelationships Retrieve a collection of trust relationships
AdminResourcesAPI GetUser Get /api/v2/users/{id} Retrieve a single user
AdminResourcesAPI GetUserDefinedFieldDefinition Get /api/v2/userDefinedFieldDefinitions/{id} Retrieve a single user-defined field defintion
AdminResourcesAPI GetUserDefinedFieldDefinitions Get /api/v2/userDefinedFieldDefinitions Retrieve a collection of user-defined field definitions
AdminResourcesAPI GetUserDefinedLinkDefinition Get /api/v2/userDefinedLinkDefinitions/{id} Retrieve a single user-defined link definition
AdminResourcesAPI GetUserDefinedLinkDefinitions Get /api/v2/userDefinedLinkDefinitions Retrieve a collection of user-defined link definitions
AdminResourcesAPI GetUserGroup Get /api/v2/users/{collectionId}/groups/{id} Retrieve a single linked group
AdminResourcesAPI GetUserGroups Get /api/v2/users/{collectionId}/groups Retrieve a collection of linked groups
AdminResourcesAPI GetUserSession Get /api/v2/users/{collectionId}/sessions/{id} Retrieve a single session
AdminResourcesAPI GetUserSessions Get /api/v2/users/{collectionId}/sessions Retrieve a collection of user sessions
AdminResourcesAPI GetUsers Get /api/v2/users Retrieve a collection of users
AdminResourcesAPI GetWorkflowRequest Get /api/v2/workflowRequests/{id} Retrieve a single workflow request
AdminResourcesAPI GetWorkflowRequests Get /api/v2/workflowRequests Retrieve a collection of workflow requests
AdminResourcesAPI PatchDatabase Patch /api/v2/databases/{id} Partially update an Address Manager database
AdminResourcesAPI PatchImport Patch /api/v2/imports/{id} Partially update a import resource
AdminResourcesAPI PatchSession Patch /api/v2/sessions/{id} Partially update a session
AdminResourcesAPI PatchSessionCurrent Patch /api/v2/sessions/current Partially update the current session
AdminResourcesAPI PatchTrustRelationship Patch /api/v2/trustRelationships/{id} Partially update a trust relationship
AdminResourcesAPI PatchUser Patch /api/v2/users/{id} Partially update a user
AdminResourcesAPI PatchWorkflowRequest Patch /api/v2/workflowRequests/{id} Partially update a workflow request
AdminResourcesAPI PostAccessRight Post /api/v2/accessRights Create a new access right
AdminResourcesAPI PostAuthenticator Post /api/v2/authenticators Configure a new authenticator
AdminResourcesAPI PostCollectionUserDefinedLink Post /api/v2/{collection}/{collectionId}/userDefinedLinks Create a new user-defined link
AdminResourcesAPI PostGroup Post /api/v2/groups Create a new group
AdminResourcesAPI PostGroupUser Post /api/v2/groups/{collectionId}/users Link a user to a group
AdminResourcesAPI PostImport Post /api/v2/imports Create a new resource import
AdminResourcesAPI PostResponsePolicyImport Post /api/v2/responsePolicies/{collectionId}/imports Create a new response policy item import
AdminResourcesAPI PostSession Post /api/v2/sessions Create a new session
AdminResourcesAPI PostSigningPolicy Post /api/v2/signingPolicies Create a new signing policy
AdminResourcesAPI PostTransaction Post /api/v2/transactions Create a new transaction
AdminResourcesAPI PostTrustRelationship Post /api/v2/trustRelationships Create a trust relationship
AdminResourcesAPI PostUser Post /api/v2/users Create a new user
AdminResourcesAPI PostUserDefinedFieldDefinition Post /api/v2/userDefinedFieldDefinitions Create a new user-defined field definition
AdminResourcesAPI PostUserDefinedLinkDefinition Post /api/v2/userDefinedLinkDefinitions Create a new user-defined link definition
AdminResourcesAPI PostUserGroup Post /api/v2/users/{collectionId}/groups Link a group to a user
AdminResourcesAPI PutAccessRight Put /api/v2/accessRights/{id} Update an access right
AdminResourcesAPI PutAuthenticator Put /api/v2/authenticators/{id} Update an authenticator
AdminResourcesAPI PutDatabase Put /api/v2/databases/{id} Updates a database resource
AdminResourcesAPI PutGroup Put /api/v2/groups/{id} Update a group
AdminResourcesAPI PutSetting Put /api/v2/settings/{id} Updates a settings resource
AdminResourcesAPI PutSigningPolicy Put /api/v2/signingPolicies/{id} Update a signing policy
AdminResourcesAPI PutUser Put /api/v2/users/{id} Update a user
AdminResourcesAPI PutUserDefinedFieldDefinition Put /api/v2/userDefinedFieldDefinitions/{id} Update a user-defined field definition
AdminResourcesAPI PutUserDefinedLinkDefinition Put /api/v2/userDefinedLinkDefinitions/{id} Update a user-defined link definition
ConfigurationResourcesAPI DeleteConfiguration Delete /api/v2/configurations/{id} Delete a configuration
ConfigurationResourcesAPI GetConfiguration Get /api/v2/configurations/{id} Retrieve a single configuration
ConfigurationResourcesAPI GetConfigurations Get /api/v2/configurations Retrieve a collection of configurations
ConfigurationResourcesAPI PostConfiguration Post /api/v2/configurations Create a new configuration
ConfigurationResourcesAPI PutConfiguration Put /api/v2/configurations/{id} Update a configuration
DHCPClientClassResourcesAPI DeleteClientClass Delete /api/v2/clientClasses/{id} Delete a client class
DHCPClientClassResourcesAPI DeleteSubclass Delete /api/v2/subclasses/{id} Delete a subclass
DHCPClientClassResourcesAPI GetClientClass Get /api/v2/clientClasses/{id} Retrieve a single client class
DHCPClientClassResourcesAPI GetClientClassSubclasses Get /api/v2/clientClasses/{collectionId}/subclasses Retrieve a collection of subclasses
DHCPClientClassResourcesAPI GetClientClasses Get /api/v2/clientClasses Retrieve a collection of client classes
DHCPClientClassResourcesAPI GetConfigurationClientClasses Get /api/v2/configurations/{collectionId}/clientClasses Retrieve a collection of client classes
DHCPClientClassResourcesAPI GetSubclass Get /api/v2/subclasses/{id} Retrieve a single subclass
DHCPClientClassResourcesAPI GetSubclasses Get /api/v2/subclasses Retrieve a collection of subclasses
DHCPClientClassResourcesAPI PostClientClassSubclass Post /api/v2/clientClasses/{collectionId}/subclasses Create a new subclass
DHCPClientClassResourcesAPI PostConfigurationClientClass Post /api/v2/configurations/{collectionId}/clientClasses Create a new client class
DHCPClientClassResourcesAPI PutClientClass Put /api/v2/clientClasses/{id} Update a client class
DHCPClientClassResourcesAPI PutSubclass Put /api/v2/subclasses/{id} Update a subclass
DHCPZoneResourcesAPI DeleteZoneDeclaration Delete /api/v2/zoneDeclarations/{id} Delete a zone declaration
DHCPZoneResourcesAPI DeleteZoneGroup Delete /api/v2/zoneGroups/{id} Delete a zone group
DHCPZoneResourcesAPI GetConfigurationZoneGroups Get /api/v2/configurations/{collectionId}/zoneGroups Retrieve a collection of zone groups
DHCPZoneResourcesAPI GetZoneDeclaration Get /api/v2/zoneDeclarations/{id} Retrieve a single zone declaration
DHCPZoneResourcesAPI GetZoneDeclarations Get /api/v2/zoneDeclarations Retrieve a collection of zone declarations
DHCPZoneResourcesAPI GetZoneGroup Get /api/v2/zoneGroups/{id} Retrieve a single zone group
DHCPZoneResourcesAPI GetZoneGroupZoneDeclarations Get /api/v2/zoneGroups/{collectionId}/zoneDeclarations Retrieve a collection of zone declarations
DHCPZoneResourcesAPI GetZoneGroups Get /api/v2/zoneGroups Retrieve a collection of zone groups
DHCPZoneResourcesAPI PostConfigurationZoneGroup Post /api/v2/configurations/{collectionId}/zoneGroups Create a new zone group
DHCPZoneResourcesAPI PostZoneGroupZoneDeclaration Post /api/v2/zoneGroups/{collectionId}/zoneDeclarations Create a new zone declaration
DHCPZoneResourcesAPI PutZoneDeclaration Put /api/v2/zoneDeclarations/{id} Update a zone declaration
DHCPZoneResourcesAPI PutZoneGroup Put /api/v2/zoneGroups/{id} Update a zone group
DNSSECResourcesAPI DeleteSigningKey Delete /api/v2/signingKeys/{id} Delete a signing key
DNSSECResourcesAPI GetCollectionSigningKeys Get /api/v2/{collection}/{collectionId}/signingKeys Retrieve a collection of signing keys
DNSSECResourcesAPI GetSigningKey Get /api/v2/signingKeys/{id} Retrieve a single signing key
DNSSECResourcesAPI GetSigningKeys Get /api/v2/signingKeys Retrieve a collection of signing keys
DNSSECResourcesAPI PatchSigningKey Patch /api/v2/signingKeys/{id} Partially update a signing key
DNSSECResourcesAPI PostCollectionSigningKey Post /api/v2/{collection}/{collectionId}/signingKeys Create a new signing key
DNSSECResourcesAPI PutSigningKey Put /api/v2/signingKeys/{id} Update a signing key
DeploymentOptionResourcesAPI DeleteDeploymentOption Delete /api/v2/deploymentOptions/{id} Delete a deployment option
DeploymentOptionResourcesAPI DeleteDeploymentOptionDefinition Delete /api/v2/deploymentOptionDefinitions/{id} Delete a deployment option definition
DeploymentOptionResourcesAPI GetCollectionDeploymentOptionDefinitions Get /api/v2/{collection}/{collectionId}/deploymentOptionDefinitions Retrieve a collection of deployment option definitions
DeploymentOptionResourcesAPI GetCollectionDeploymentOptions Get /api/v2/{collection}/{collectionId}/deploymentOptions Retrieve a collection of deployment options
DeploymentOptionResourcesAPI GetDeploymentOption Get /api/v2/deploymentOptions/{id} Retrieve a single deployment option
DeploymentOptionResourcesAPI GetDeploymentOptionDefinition Get /api/v2/deploymentOptionDefinitions/{id} Retrieve a single deployment option definition
DeploymentOptionResourcesAPI GetDeploymentOptionDefinitions Get /api/v2/deploymentOptionDefinitions Retrieve a collection of deployment option definitions
DeploymentOptionResourcesAPI GetDeploymentOptions Get /api/v2/deploymentOptions Retrieve a collection of deployment options
DeploymentOptionResourcesAPI PostCollectionDeploymentOption Post /api/v2/{collection}/{collectionId}/deploymentOptions Create a new deployment option
DeploymentOptionResourcesAPI PostCollectionDeploymentOptionDefinition Post /api/v2/{collection}/{collectionId}/deploymentOptionDefinitions Create a new deployment option definition
DeploymentOptionResourcesAPI PutDeploymentOption Put /api/v2/deploymentOptions/{id} Update a deployment option
DeploymentOptionResourcesAPI PutDeploymentOptionDefinition Put /api/v2/deploymentOptionDefinitions/{id} Update a deployment option definition
DeploymentRoleResourcesAPI DeleteDeploymentRole Delete /api/v2/deploymentRoles/{id} Delete a deployment role
DeploymentRoleResourcesAPI GetCollectionDeploymentRoles Get /api/v2/{collection}/{collectionId}/deploymentRoles Retrieve a collection of deployment roles
DeploymentRoleResourcesAPI GetDeploymentRole Get /api/v2/deploymentRoles/{id} Retrieve a single deployment role
DeploymentRoleResourcesAPI GetDeploymentRoles Get /api/v2/deploymentRoles Retrieve a collection of deployment roles
DeploymentRoleResourcesAPI GetServerDeploymentRole Get /api/v2/servers/{collectionId}/deploymentRoles/{id} Retrieve a single linked deployment role
DeploymentRoleResourcesAPI GetServerDeploymentRoles Get /api/v2/servers/{collectionId}/deploymentRoles Retrieve a collection of linked deployment roles
DeploymentRoleResourcesAPI PostCollectionDeploymentRole Post /api/v2/{collection}/{collectionId}/deploymentRoles Create a new deployment role
DeploymentRoleResourcesAPI PutDeploymentRole Put /api/v2/deploymentRoles/{id} Update a deployment role
DeviceResourcesAPI DeleteDevice Delete /api/v2/devices/{id} Delete a device
DeviceResourcesAPI DeleteDeviceSubtype Delete /api/v2/deviceSubtypes/{id} Delete a device subtype
DeviceResourcesAPI DeleteDeviceType Delete /api/v2/deviceTypes/{id} Delete a device type
DeviceResourcesAPI GetConfigurationDevices Get /api/v2/configurations/{collectionId}/devices Retrieve a collection of devices
DeviceResourcesAPI GetDevice Get /api/v2/devices/{id} Retrieve a single device
DeviceResourcesAPI GetDeviceSubtype Get /api/v2/deviceSubtypes/{id} Retrieve a single device subtype
DeviceResourcesAPI GetDeviceSubtypes Get /api/v2/deviceSubtypes Retrieve a collection of device subtypes
DeviceResourcesAPI GetDeviceType Get /api/v2/deviceTypes/{id} Retrieve a single device type
DeviceResourcesAPI GetDeviceTypeDeviceSubtypes Get /api/v2/deviceTypes/{collectionId}/deviceSubtypes Retrieve a collection of device subtypes
DeviceResourcesAPI GetDeviceTypes Get /api/v2/deviceTypes Retrieve a collection of device types
DeviceResourcesAPI GetDevices Get /api/v2/devices Retrieve a collection of devices
DeviceResourcesAPI PostConfigurationDevice Post /api/v2/configurations/{collectionId}/devices Create a new device
DeviceResourcesAPI PostDeviceType Post /api/v2/deviceTypes Create a new device type
DeviceResourcesAPI PostDeviceTypeDeviceSubtype Post /api/v2/deviceTypes/{collectionId}/deviceSubtypes Create a new device subtype
DeviceResourcesAPI PutDevice Put /api/v2/devices/{id} Update a device
DeviceResourcesAPI PutDeviceSubtype Put /api/v2/deviceSubtypes/{id} Update a device subtype
DeviceResourcesAPI PutDeviceType Put /api/v2/deviceTypes/{id} Update a device type
FavoriteResourcesAPI DeleteUserFavorite Delete /api/v2/users/{collectionId}/favorites/{id} Delete a favorite
FavoriteResourcesAPI GetUserFavorites Get /api/v2/users/{collectionId}/favorites Retrieve a collection of favorites
FavoriteResourcesAPI PostUserFavorite Post /api/v2/users/{collectionId}/favorites Create a new favorite
IPv4AndIPv6ResourcesAPI DeleteAddress Delete /api/v2/addresses/{id} Delete an address
IPv4AndIPv6ResourcesAPI DeleteBlock Delete /api/v2/blocks/{id} Delete a block
IPv4AndIPv6ResourcesAPI DeleteCollectionAddress Delete /api/v2/{collection}/{collectionId}/addresses/{id} Unlink an address from a resource
IPv4AndIPv6ResourcesAPI DeleteCollectionAppliedResource Delete /api/v2/{collection}/{collectionId}/appliedResources/{id} Remove a template or policy application from a resource
IPv4AndIPv6ResourcesAPI DeleteCollectionRestrictedRange Delete /api/v2/{collection}/{collectionId}/restrictedRanges/{id} Delete a restricted range
IPv4AndIPv6ResourcesAPI DeleteIpGroup Delete /api/v2/ipGroups/{id} Delete an IP group
IPv4AndIPv6ResourcesAPI DeleteNetwork Delete /api/v2/networks/{id} Delete a network
IPv4AndIPv6ResourcesAPI DeleteRange Delete /api/v2/ranges/{id} Delete a range
IPv4AndIPv6ResourcesAPI DeleteReconciliationPolicy Delete /api/v2/reconciliationPolicies/{id} Delete a reconciliation policy
IPv4AndIPv6ResourcesAPI DeleteTemplate Delete /api/v2/templates/{id} Delete a template
IPv4AndIPv6ResourcesAPI DeleteTemplateItem Delete /api/v2/templateItems/{id} Delete a template item
IPv4AndIPv6ResourcesAPI GetAddress Get /api/v2/addresses/{id} Retrieve a single address
IPv4AndIPv6ResourcesAPI GetAddresses Get /api/v2/addresses Retrieve a collection of addresses
IPv4AndIPv6ResourcesAPI GetBlock Get /api/v2/blocks/{id} Retrieve a single block
IPv4AndIPv6ResourcesAPI GetBlockBlocks Get /api/v2/blocks/{collectionId}/blocks Retrieve a collection of blocks
IPv4AndIPv6ResourcesAPI GetBlockNetworks Get /api/v2/blocks/{collectionId}/networks Retrieve a collection of networks
IPv4AndIPv6ResourcesAPI GetBlocks Get /api/v2/blocks Retrieve a collection of blocks
IPv4AndIPv6ResourcesAPI GetCollectionAddress Get /api/v2/{collection}/{collectionId}/addresses/{id} Retrieve a single linked address
IPv4AndIPv6ResourcesAPI GetCollectionAddresses Get /api/v2/{collection}/{collectionId}/addresses Retrieve a collection of linked addresss
IPv4AndIPv6ResourcesAPI GetCollectionAppliedResource Get /api/v2/{collection}/{collectionId}/appliedResources/{id} Retrieve an applied resource
IPv4AndIPv6ResourcesAPI GetCollectionAppliedResources Get /api/v2/{collection}/{collectionId}/appliedResources Retrieve a collection of applied resources
IPv4AndIPv6ResourcesAPI GetCollectionLeases Get /api/v2/{collection}/{collectionId}/leases Retrieve a collection of leases
IPv4AndIPv6ResourcesAPI GetCollectionMerges Get /api/v2/{collection}/{collectionId}/merges Retrieve a collection of merges
IPv4AndIPv6ResourcesAPI GetCollectionMoves Get /api/v2/{collection}/{collectionId}/moves Retrieve a collection of moves
IPv4AndIPv6ResourcesAPI GetCollectionReconciliationPolicies Get /api/v2/{collection}/{collectionId}/reconciliationPolicies Retrieve a collection of reconciliation policies
IPv4AndIPv6ResourcesAPI GetCollectionRestrictedRange Get /api/v2/{collection}/{collectionId}/restrictedRanges/{id} Retrieve a single restricted range
IPv4AndIPv6ResourcesAPI GetCollectionRestrictedRanges Get /api/v2/{collection}/{collectionId}/restrictedRanges Retrieve a collection of restricted ranges
IPv4AndIPv6ResourcesAPI GetCollectionSplits Get /api/v2/{collection}/{collectionId}/splits Retrieve a collection of split resources
IPv4AndIPv6ResourcesAPI GetCollectionTemplateApplications Get /api/v2/{collection}/{collectionId}/templateApplications Retrieve a collection of template applications
IPv4AndIPv6ResourcesAPI GetCollectionTemplates Get /api/v2/{collection}/{collectionId}/templates Retrieve a collection of templates
IPv4AndIPv6ResourcesAPI GetConfigurationBlocks Get /api/v2/configurations/{collectionId}/blocks Retrieve a collection of blocks
IPv4AndIPv6ResourcesAPI GetIpGroup Get /api/v2/ipGroups/{id} Retrieve a single IP group
IPv4AndIPv6ResourcesAPI GetIpGroups Get /api/v2/ipGroups Retrieve a collection of IP groups
IPv4AndIPv6ResourcesAPI GetLease Get /api/v2/leases/{id} Retrieve a single lease
IPv4AndIPv6ResourcesAPI GetLeases Get /api/v2/leases Retrieve a collection of leases
IPv4AndIPv6ResourcesAPI GetMerge Get /api/v2/merges/{id} Retrieve a single merge
IPv4AndIPv6ResourcesAPI GetMergeBlock Get /api/v2/merges/{collectionId}/blocks/{id} Retrieve a single merged block
IPv4AndIPv6ResourcesAPI GetMergeBlocks Get /api/v2/merges/{collectionId}/blocks Retrieve a collection of merged block
IPv4AndIPv6ResourcesAPI GetMergeNetwork Get /api/v2/merges/{collectionId}/networks/{id} Retrieve a single merged network
IPv4AndIPv6ResourcesAPI GetMergeNetworks Get /api/v2/merges/{collectionId}/networks Retrieve a collection of merged networks
IPv4AndIPv6ResourcesAPI GetMergeRange Get /api/v2/merges/{collectionId}/ranges/{id} Retrieve a single merged IPv4 DHCP range
IPv4AndIPv6ResourcesAPI GetMergeRanges Get /api/v2/merges/{collectionId}/ranges Retrieve a collection of merged DHCP ranges
IPv4AndIPv6ResourcesAPI GetMerges Get /api/v2/merges Retrieve a collection of merges
IPv4AndIPv6ResourcesAPI GetMove Get /api/v2/moves/{id} Retrieve a single move
IPv4AndIPv6ResourcesAPI GetMoves Get /api/v2/moves Retrieve a collection of moves
IPv4AndIPv6ResourcesAPI GetNetwork Get /api/v2/networks/{id} Retrieve a single network
IPv4AndIPv6ResourcesAPI GetNetworkAddresses Get /api/v2/networks/{collectionId}/addresses Retrieve a collection of addresses
IPv4AndIPv6ResourcesAPI GetNetworkIpGroups Get /api/v2/networks/{collectionId}/ipGroups Retrieve a collection of IP groups
IPv4AndIPv6ResourcesAPI GetNetworkRanges Get /api/v2/networks/{collectionId}/ranges Retrieve a collection of ranges
IPv4AndIPv6ResourcesAPI GetNetworks Get /api/v2/networks Retrieve a collection of networks
IPv4AndIPv6ResourcesAPI GetRange Get /api/v2/ranges/{id} Retrieve a single range
IPv4AndIPv6ResourcesAPI GetRanges Get /api/v2/ranges Retrieve a collection of ranges
IPv4AndIPv6ResourcesAPI GetReconciliationPolicies Get /api/v2/reconciliationPolicies Retrieve a collection of reconciliation policies
IPv4AndIPv6ResourcesAPI GetReconciliationPolicy Get /api/v2/reconciliationPolicies/{id} Retrieve a single reconciliation policy
IPv4AndIPv6ResourcesAPI GetReconciliationPolicyDiscoveredDevice Get /api/v2/reconciliationPolicies/{collectionId}/discoveredDevices/{id} Retrieve a single discovered device
IPv4AndIPv6ResourcesAPI GetReconciliationPolicyDiscoveredDevices Get /api/v2/reconciliationPolicies/{collectionId}/discoveredDevices Retrieve a collection of discovered devices
IPv4AndIPv6ResourcesAPI GetSplit Get /api/v2/splits/{id} Retrieve a single split resource
IPv4AndIPv6ResourcesAPI GetSplitBlock Get /api/v2/splits/{collectionId}/blocks/{id} Retrieve a single block partition
IPv4AndIPv6ResourcesAPI GetSplitBlocks Get /api/v2/splits/{collectionId}/blocks Retrieve a collection of block partitions
IPv4AndIPv6ResourcesAPI GetSplitNetwork Get /api/v2/splits/{collectionId}/networks/{id} Retrieve a single network partition
IPv4AndIPv6ResourcesAPI GetSplitNetworks Get /api/v2/splits/{collectionId}/networks Retrieve a collection of network partitions
IPv4AndIPv6ResourcesAPI GetSplits Get /api/v2/splits Retrieve a collection of split resources
IPv4AndIPv6ResourcesAPI GetTemplate Get /api/v2/templates/{id} Retrieve a single template
IPv4AndIPv6ResourcesAPI GetTemplateApplication Get /api/v2/templateApplications/{id} Retrieve a single template application
IPv4AndIPv6ResourcesAPI GetTemplateApplications Get /api/v2/templateApplications Retrieve a collection of template applications
IPv4AndIPv6ResourcesAPI GetTemplateConflictingResource Get /api/v2/templates/{collectionId}/conflictingResources/{id} Retrieve a conflicting resource
IPv4AndIPv6ResourcesAPI GetTemplateConflictingResources Get /api/v2/templates/{collectionId}/conflictingResources Retrieve a collection of conflicting resources
IPv4AndIPv6ResourcesAPI GetTemplateItem Get /api/v2/templateItems/{id} Retrieve a single template item
IPv4AndIPv6ResourcesAPI GetTemplateItems Get /api/v2/templateItems Retrieve a collection of template items
IPv4AndIPv6ResourcesAPI GetTemplateTemplateItems Get /api/v2/templates/{collectionId}/templateItems Retrieve a collection of template items
IPv4AndIPv6ResourcesAPI GetTemplates Get /api/v2/templates Retrieve a collection of templates
IPv4AndIPv6ResourcesAPI PostBlockBlock Post /api/v2/blocks/{collectionId}/blocks Create a new block
IPv4AndIPv6ResourcesAPI PostBlockNetwork Post /api/v2/blocks/{collectionId}/networks Create a new network
IPv4AndIPv6ResourcesAPI PostCollectionAddress Post /api/v2/{collection}/{collectionId}/addresses Link an address to a resource
IPv4AndIPv6ResourcesAPI PostCollectionAppliedResource Post /api/v2/{collection}/{collectionId}/appliedResources Apply a template or policy to a resource
IPv4AndIPv6ResourcesAPI PostCollectionMerge Post /api/v2/{collection}/{collectionId}/merges Create a new merge
IPv4AndIPv6ResourcesAPI PostCollectionMove Post /api/v2/{collection}/{collectionId}/moves Create a new move
IPv4AndIPv6ResourcesAPI PostCollectionReconciliationPolicy Post /api/v2/{collection}/{collectionId}/reconciliationPolicies Create a new reconciliation policy
IPv4AndIPv6ResourcesAPI PostCollectionRestrictedRange Post /api/v2/{collection}/{collectionId}/restrictedRanges Create a new restricted range
IPv4AndIPv6ResourcesAPI PostCollectionSplit Post /api/v2/{collection}/{collectionId}/splits Create a new split resource
IPv4AndIPv6ResourcesAPI PostCollectionTemplate Post /api/v2/{collection}/{collectionId}/templates Create a new template
IPv4AndIPv6ResourcesAPI PostCollectionTemplateApplication Post /api/v2/{collection}/{collectionId}/templateApplications Create a new template application
IPv4AndIPv6ResourcesAPI PostConfigurationBlock Post /api/v2/configurations/{collectionId}/blocks Create a new block
IPv4AndIPv6ResourcesAPI PostNetworkAddress Post /api/v2/networks/{collectionId}/addresses Create a new address
IPv4AndIPv6ResourcesAPI PostNetworkIpGroup Post /api/v2/networks/{collectionId}/ipGroups Create a new IP group
IPv4AndIPv6ResourcesAPI PostNetworkRange Post /api/v2/networks/{collectionId}/ranges Create a new range
IPv4AndIPv6ResourcesAPI PostTemplateTemplateItem Post /api/v2/templates/{collectionId}/templateItems Create a new template item
IPv4AndIPv6ResourcesAPI PutAddress Put /api/v2/addresses/{id} Update an address
IPv4AndIPv6ResourcesAPI PutBlock Put /api/v2/blocks/{id} Update a block
IPv4AndIPv6ResourcesAPI PutIpGroup Put /api/v2/ipGroups/{id} Update an IP group
IPv4AndIPv6ResourcesAPI PutNetwork Put /api/v2/networks/{id} Update a network
IPv4AndIPv6ResourcesAPI PutRange Put /api/v2/ranges/{id} Update a range
IPv4AndIPv6ResourcesAPI PutReconciliationPolicy Put /api/v2/reconciliationPolicies/{id} Update a reconciliation policy
IPv4AndIPv6ResourcesAPI PutTemplate Put /api/v2/templates/{id} Update a template
IPv4AndIPv6ResourcesAPI PutTemplateItem Put /api/v2/templateItems/{id} Update a template item
KerberosResourcesAPI DeleteKeyDistributionCenter Delete /api/v2/keyDistributionCenters/{id} Delete a key distribution center
KerberosResourcesAPI DeleteRealm Delete /api/v2/realms/{id} Delete a realm
KerberosResourcesAPI DeleteServicePrincipal Delete /api/v2/servicePrincipals/{id} Delete a service principal
KerberosResourcesAPI GetConfigurationRealms Get /api/v2/configurations/{collectionId}/realms Retrieve a collection of realms
KerberosResourcesAPI GetKeyDistributionCenter Get /api/v2/keyDistributionCenters/{id} Retrieve a single key distribution center
KerberosResourcesAPI GetKeyDistributionCenters Get /api/v2/keyDistributionCenters Retrieve a collection of key distribution centers
KerberosResourcesAPI GetRealm Get /api/v2/realms/{id} Retrieve a single realm
KerberosResourcesAPI GetRealmKeyDistributionCenters Get /api/v2/realms/{collectionId}/keyDistributionCenters Retrieve a collection of key distribution centers
KerberosResourcesAPI GetRealmServicePrincipals Get /api/v2/realms/{collectionId}/servicePrincipals Retrieve a collection of service principals
KerberosResourcesAPI GetRealms Get /api/v2/realms Retrieve a collection of realms
KerberosResourcesAPI GetServicePrincipal Get /api/v2/servicePrincipals/{id} Retrieve a single service principal
KerberosResourcesAPI GetServicePrincipals Get /api/v2/servicePrincipals Retrieve a collection of service principals
KerberosResourcesAPI PatchServicePrincipal Patch /api/v2/servicePrincipals/{id} Partially update a service principal
KerberosResourcesAPI PostConfigurationRealm Post /api/v2/configurations/{collectionId}/realms Create a new Kerberos realm
KerberosResourcesAPI PostRealmKeyDistributionCenter Post /api/v2/realms/{collectionId}/keyDistributionCenters Create a new key distribution center
KerberosResourcesAPI PostRealmServicePrincipal Post /api/v2/realms/{collectionId}/servicePrincipals Create a new service principal
KerberosResourcesAPI PutKeyDistributionCenter Put /api/v2/keyDistributionCenters/{id} Update a key distribution center
KerberosResourcesAPI PutRealm Put /api/v2/realms/{id} Update a realm
KerberosResourcesAPI PutServicePrincipal Put /api/v2/servicePrincipals/{id} Update a service principal
LocationResourcesAPI DeleteLocation Delete /api/v2/locations/{id} Delete a location
LocationResourcesAPI DeleteLocationAnnotatedResource Delete /api/v2/locations/{collectionId}/annotatedResources/{id} Remove a location annotation from a resource
LocationResourcesAPI GetLocation Get /api/v2/locations/{id} Retrieve a single location
LocationResourcesAPI GetLocationAnnotatedResource Get /api/v2/locations/{collectionId}/annotatedResources/{id} Retrieve a location annotated resource
LocationResourcesAPI GetLocationAnnotatedResources Get /api/v2/locations/{collectionId}/annotatedResources Retrieve a collection of location annotated resources
LocationResourcesAPI GetLocationLocations Get /api/v2/locations/{collectionId}/locations Retrieve a collection of locations
LocationResourcesAPI GetLocations Get /api/v2/locations Retrieve a collection of locations
LocationResourcesAPI PostLocationAnnotatedResource Post /api/v2/locations/{collectionId}/annotatedResources Annotate a resource with a location
LocationResourcesAPI PostLocationLocation Post /api/v2/locations/{collectionId}/locations Create a new location
LocationResourcesAPI PutLocation Put /api/v2/locations/{id} Update a location
MACAddressAndClientIdentifierResourcesAPI DeleteMacAddress Delete /api/v2/macAddresses/{id} Delete a MAC address
MACAddressAndClientIdentifierResourcesAPI DeleteMacPool Delete /api/v2/macPools/{id} Delete a MAC pool
MACAddressAndClientIdentifierResourcesAPI DeleteMacPoolMacAddress Delete /api/v2/macPools/{collectionId}/macAddresses/{id} Unlink a MAC address from a MAC pool
MACAddressAndClientIdentifierResourcesAPI GetClientIdentifier Get /api/v2/clientIdentifiers/{id} Retrieve a single client identifier
MACAddressAndClientIdentifierResourcesAPI GetClientIdentifiers Get /api/v2/clientIdentifiers Retrieve a collection of client identifiers
MACAddressAndClientIdentifierResourcesAPI GetConfigurationClientIdentifiers Get /api/v2/configurations/{collectionId}/clientIdentifiers Retrieve a collection of client identifiers
MACAddressAndClientIdentifierResourcesAPI GetConfigurationMacAddresses Get /api/v2/configurations/{collectionId}/macAddresses Retrieve a collection of MAC addresses
MACAddressAndClientIdentifierResourcesAPI GetConfigurationMacPools Get /api/v2/configurations/{collectionId}/macPools Retrieve a collection of MAC pools
MACAddressAndClientIdentifierResourcesAPI GetMacAddress Get /api/v2/macAddresses/{id} Retrieve a single MAC address
MACAddressAndClientIdentifierResourcesAPI GetMacAddresses Get /api/v2/macAddresses Retrieve a collection of MAC addresses
MACAddressAndClientIdentifierResourcesAPI GetMacPool Get /api/v2/macPools/{id} Retrieve a single MAC pool
MACAddressAndClientIdentifierResourcesAPI GetMacPoolMacAddress Get /api/v2/macPools/{collectionId}/macAddresses/{id} Retrieve a single linked MAC address
MACAddressAndClientIdentifierResourcesAPI GetMacPoolMacAddresses Get /api/v2/macPools/{collectionId}/macAddresses Retrieve a collection of linked MAC addresses
MACAddressAndClientIdentifierResourcesAPI GetMacPools Get /api/v2/macPools Retrieve a collection of MAC pools
MACAddressAndClientIdentifierResourcesAPI PostConfigurationMacAddress Post /api/v2/configurations/{collectionId}/macAddresses Create a new MAC address
MACAddressAndClientIdentifierResourcesAPI PostConfigurationMacPool Post /api/v2/configurations/{collectionId}/macPools Create a new MAC pool
MACAddressAndClientIdentifierResourcesAPI PostMacPoolMacAddress Post /api/v2/macPools/{collectionId}/macAddresses Link a MAC address to a MAC pool
MACAddressAndClientIdentifierResourcesAPI PutMacAddress Put /api/v2/macAddresses/{id} Update a MAC address
MACAddressAndClientIdentifierResourcesAPI PutMacPool Put /api/v2/macPools/{id} Update a MAC pool
NamingPolicyResourcesAPI DeleteCollectionNamingPolicy Delete /api/v2/{collection}/{collectionId}/namingPolicies/{id} Unapply naming policy
NamingPolicyResourcesAPI DeleteNamingPolicy Delete /api/v2/namingPolicies/{id} Delete a naming policy
NamingPolicyResourcesAPI DeleteNamingPolicyRestriction Delete /api/v2/namingPolicyRestrictions/{id} Delete a naming restriction
NamingPolicyResourcesAPI DeleteNamingPolicyValue Delete /api/v2/namingPolicyValues/{id} Delete a naming policy value
NamingPolicyResourcesAPI GetCollectionNamingPolicies Get /api/v2/{collection}/{collectionId}/namingPolicies Retrieve a collection of applied naming policies
NamingPolicyResourcesAPI GetCollectionNamingPolicy Get /api/v2/{collection}/{collectionId}/namingPolicies/{id} Retrieve an applied naming policy
NamingPolicyResourcesAPI GetNamingPolicies Get /api/v2/namingPolicies Retrieve a collection of naming policies
NamingPolicyResourcesAPI GetNamingPolicy Get /api/v2/namingPolicies/{id} Retrieve a single naming policy
NamingPolicyResourcesAPI GetNamingPolicyPolicyRestriction Get /api/v2/namingPolicies/{collectionId}/policyRestrictions/{id} Retrieve a single naming policy restriction
NamingPolicyResourcesAPI GetNamingPolicyPolicyRestrictions Get /api/v2/namingPolicies/{collectionId}/policyRestrictions Retrieve a collection of naming policy restrictions
NamingPolicyResourcesAPI GetNamingPolicyPolicyValue Get /api/v2/namingPolicies/{collectionId}/policyValues/{id} Retrieve a single naming policy value
NamingPolicyResourcesAPI GetNamingPolicyPolicyValues Get /api/v2/namingPolicies/{collectionId}/policyValues Retrieve a collection of naming policy values
NamingPolicyResourcesAPI GetNamingPolicyRestriction Get /api/v2/namingPolicyRestrictions/{id} Retrieve a single naming restriction
NamingPolicyResourcesAPI GetNamingPolicyRestrictions Get /api/v2/namingPolicyRestrictions Retrieve a collection of naming restrictions
NamingPolicyResourcesAPI GetNamingPolicyValue Get /api/v2/namingPolicyValues/{id} Retrieve a single naming policy value
NamingPolicyResourcesAPI GetNamingPolicyValues Get /api/v2/namingPolicyValues Retrieve a collection of naming policy values
NamingPolicyResourcesAPI PostCollectionNamingPolicy Post /api/v2/{collection}/{collectionId}/namingPolicies Apply a naming policy
NamingPolicyResourcesAPI PostNamingPolicy Post /api/v2/namingPolicies Create a new naming policy
NamingPolicyResourcesAPI PostNamingPolicyRestriction Post /api/v2/namingPolicyRestrictions Create a new naming restriction
NamingPolicyResourcesAPI PostNamingPolicyValue Post /api/v2/namingPolicyValues Create a new naming policy value
NamingPolicyResourcesAPI PutNamingPolicy Put /api/v2/namingPolicies/{id} Update a naming policy
NamingPolicyResourcesAPI PutNamingPolicyRestriction Put /api/v2/namingPolicyRestrictions/{id} Update a naming restriction
NamingPolicyResourcesAPI PutNamingPolicyValue Put /api/v2/namingPolicyValues/{id} Update a naming policy value
ResourceRecordResourcesAPI DeleteAddressResourceRecord Delete /api/v2/addresses/{collectionId}/resourceRecords/{id} Delete a linked resource record
ResourceRecordResourcesAPI DeleteResourceRecord Delete /api/v2/resourceRecords/{id} Delete a resource record
ResourceRecordResourcesAPI GetAddressResourceRecord Get /api/v2/addresses/{collectionId}/resourceRecords/{id} Retrieve a single linked resource record
ResourceRecordResourcesAPI GetAddressResourceRecords Get /api/v2/addresses/{collectionId}/resourceRecords Retrieve a collection of linked resource records
ResourceRecordResourcesAPI GetCollectionResourceRecords Get /api/v2/{collection}/{collectionId}/resourceRecords Retrieve a collection of resource records
ResourceRecordResourcesAPI GetDeploymentAddedRecord Get /api/v2/deployments/{collectionId}/addedRecords/{id} Retrieve a single resource record
ResourceRecordResourcesAPI GetDeploymentAddedRecords Get /api/v2/deployments/{collectionId}/addedRecords Retrieve a collection of resource records
ResourceRecordResourcesAPI GetDeploymentDeletedRecord Get /api/v2/deployments/{collectionId}/deletedRecords/{id} Retrieve a single resource record
ResourceRecordResourcesAPI GetDeploymentDeletedRecords Get /api/v2/deployments/{collectionId}/deletedRecords Retrieve a collection of resource records
ResourceRecordResourcesAPI GetDeploymentUpdatedRecord Get /api/v2/deployments/{collectionId}/updatedRecords/{id} Retrieve a single resource record
ResourceRecordResourcesAPI GetDeploymentUpdatedRecords Get /api/v2/deployments/{collectionId}/updatedRecords Retrieve a collection of resource records
ResourceRecordResourcesAPI GetResourceRecord Get /api/v2/resourceRecords/{id} Retrieve a single resource record
ResourceRecordResourcesAPI GetResourceRecordDependentRecord Get /api/v2/resourceRecords/{collectionId}/dependentRecords/{id} Retrieve a single dependent resource record
ResourceRecordResourcesAPI GetResourceRecordDependentRecords Get /api/v2/resourceRecords/{collectionId}/dependentRecords Retrieve a collection of dependent records
ResourceRecordResourcesAPI GetResourceRecords Get /api/v2/resourceRecords Retrieve a collection of resource records
ResourceRecordResourcesAPI PostAddressResourceRecord Post /api/v2/addresses/{collectionId}/resourceRecords Link a resource record to an address
ResourceRecordResourcesAPI PostCollectionResourceRecord Post /api/v2/{collection}/{collectionId}/resourceRecords Create a new resource record
ResourceRecordResourcesAPI PutResourceRecord Put /api/v2/resourceRecords/{id} Update a resource record
ServerResourcesAPI DeleteCollectionServer Delete /api/v2/{collection}/{collectionId}/servers/{id} Unlink a server from a server group
ServerResourcesAPI DeleteDatabaseServer Delete /api/v2/databases/{collectionId}/servers/{id} Removes a server from a database replication cluster
ServerResourcesAPI DeleteInterface Delete /api/v2/interfaces/{id} Delete an interface
ServerResourcesAPI DeleteServer Delete /api/v2/servers/{id} Delete a server
ServerResourcesAPI DeleteServerGroup Delete /api/v2/serverGroups/{id} Delete a server group
ServerResourcesAPI GetCollectionDeployments Get /api/v2/{collection}/{collectionId}/deployments Retrieve a collection of deployments
ServerResourcesAPI GetCollectionMoves Get /api/v2/{collection}/{collectionId}/moves Retrieve a collection of moves
ServerResourcesAPI GetCollectionServer Get /api/v2/{collection}/{collectionId}/servers/{id} Retrieve a single linked server
ServerResourcesAPI GetCollectionServers Get /api/v2/{collection}/{collectionId}/servers Retrieve a collection of linked servers
ServerResourcesAPI GetConfigurationServerGroups Get /api/v2/configurations/{collectionId}/serverGroups Retrieve a collection of server groups
ServerResourcesAPI GetConfigurationServers Get /api/v2/configurations/{collectionId}/servers Retrieve a collection of servers
ServerResourcesAPI GetDatabaseServer Get /api/v2/databases/{collectionId}/servers/{id} Retrieve a single database server
ServerResourcesAPI GetDatabaseServers Get /api/v2/databases/{collectionId}/servers Retrieve a collection of database servers
ServerResourcesAPI GetDeployment Get /api/v2/deployments/{id} Retrieve a single deployment
ServerResourcesAPI GetDeploymentRoleInterfaces Get /api/v2/deploymentRoles/{collectionId}/interfaces Retrieve a collection of interfaces
ServerResourcesAPI GetDeployments Get /api/v2/deployments Retrieve a collection of deployments
ServerResourcesAPI GetInterface Get /api/v2/interfaces/{id} Retrieve a single interface
ServerResourcesAPI GetInterfaces Get /api/v2/interfaces Retrieve a collection of interfaces
ServerResourcesAPI GetMove Get /api/v2/moves/{id} Retrieve a single move
ServerResourcesAPI GetMoves Get /api/v2/moves Retrieve a collection of moves
ServerResourcesAPI GetServer Get /api/v2/servers/{id} Retrieve a single server
ServerResourcesAPI GetServerGroup Get /api/v2/serverGroups/{id} Retrieve a single server group
ServerResourcesAPI GetServerGroups Get /api/v2/serverGroups Retrieve a collection of server groups
ServerResourcesAPI GetServerInterfaces Get /api/v2/servers/{collectionId}/interfaces Retrieve a collection of interfaces
ServerResourcesAPI GetServerServers Get /api/v2/servers/{collectionId}/servers Retrieve a collection of servers
ServerResourcesAPI GetServerService Get /api/v2/servers/{collectionId}/services/{id} Retrieve a single server service
ServerResourcesAPI GetServerServices Get /api/v2/servers/{collectionId}/services Retrieve a collection of server services
ServerResourcesAPI GetServers Get /api/v2/servers Retrieve a collection of servers
ServerResourcesAPI PatchDatabaseServer Patch /api/v2/databases/{collectionId}/servers/{id} Partially update a server from a database replication cluster
ServerResourcesAPI PatchServer Patch /api/v2/servers/{id} Partially update a server
ServerResourcesAPI PostCollectionDeployment Post /api/v2/{collection}/{collectionId}/deployments Create a new deployment
ServerResourcesAPI PostCollectionMove Post /api/v2/{collection}/{collectionId}/moves Create a new move
ServerResourcesAPI PostCollectionServer Post /api/v2/{collection}/{collectionId}/servers Link a server to a server group
ServerResourcesAPI PostConfigurationServer Post /api/v2/configurations/{collectionId}/servers Create a new server
ServerResourcesAPI PostConfigurationServerGroup Post /api/v2/configurations/{collectionId}/serverGroups Create a new server group
ServerResourcesAPI PostDatabaseServer Post /api/v2/databases/{collectionId}/servers Add a standby server for database replication
ServerResourcesAPI PostDeployment Post /api/v2/deployments Create a new deployment
ServerResourcesAPI PostServerInterface Post /api/v2/servers/{collectionId}/interfaces Create a new interface
ServerResourcesAPI PutInterface Put /api/v2/interfaces/{id} Update an interface
ServerResourcesAPI PutServer Put /api/v2/servers/{id} Update a server
ServerResourcesAPI PutServerGroup Put /api/v2/serverGroups/{id} Update a server group
ServerResourcesAPI PutServerService Put /api/v2/servers/{collectionId}/services/{id} Update a server service
TFTPResourcesAPI DeleteFile Delete /api/v2/files/{id} Delete a file
TFTPResourcesAPI DeleteTftpGroup Delete /api/v2/tftpGroups/{id} Delete a TFTP group
TFTPResourcesAPI GetCollectionFiles Get /api/v2/{collection}/{collectionId}/files Retrieve a collection of files
TFTPResourcesAPI GetConfigurationTftpGroups Get /api/v2/configurations/{collectionId}/tftpGroups Retrieve a collection of TFTP groups
TFTPResourcesAPI GetFile Get /api/v2/files/{id} Retrieve a single file
TFTPResourcesAPI GetFiles Get /api/v2/files Retrieve a collection of files
TFTPResourcesAPI GetTftpGroup Get /api/v2/tftpGroups/{id} Retrieve a single TFTP group
TFTPResourcesAPI GetTftpGroups Get /api/v2/tftpGroups Retrieve a collection of TFTP groups
TFTPResourcesAPI PostCollectionFile Post /api/v2/{collection}/{collectionId}/files Create a new file
TFTPResourcesAPI PostConfigurationTftpGroup Post /api/v2/configurations/{collectionId}/tftpGroups Create a new TFTP group
TFTPResourcesAPI PutFile Put /api/v2/files/{id} Update a file
TFTPResourcesAPI PutTftpGroup Put /api/v2/tftpGroups/{id} Update a TFTP group
TSIGKeyResourcesAPI DeleteSigningKey Delete /api/v2/signingKeys/{id} Delete a signing key
TSIGKeyResourcesAPI GetCollectionSigningKeys Get /api/v2/{collection}/{collectionId}/signingKeys Retrieve a collection of signing keys
TSIGKeyResourcesAPI GetSigningKey Get /api/v2/signingKeys/{id} Retrieve a single signing key
TSIGKeyResourcesAPI GetSigningKeys Get /api/v2/signingKeys Retrieve a collection of signing keys
TSIGKeyResourcesAPI PatchSigningKey Patch /api/v2/signingKeys/{id} Partially update a signing key
TSIGKeyResourcesAPI PostCollectionSigningKey Post /api/v2/{collection}/{collectionId}/signingKeys Create a new signing key
TSIGKeyResourcesAPI PutSigningKey Put /api/v2/signingKeys/{id} Update a signing key
TagResourcesAPI DeleteCollectionTag Delete /api/v2/{collection}/{collectionId}/tags/{id} Unlink a tag from a resource
TagResourcesAPI DeleteTag Delete /api/v2/tags/{id} Delete a tag
TagResourcesAPI DeleteTagGroup Delete /api/v2/tagGroups/{id} Delete a tag group
TagResourcesAPI DeleteTagSharedResource Delete /api/v2/tags/{collectionId}/sharedResources/{id} Delete a shared resource
TagResourcesAPI DeleteTagTaggedResource Delete /api/v2/tags/{collectionId}/taggedResources/{id} Delete a tagged resource
TagResourcesAPI GetCollectionTag Get /api/v2/{collection}/{collectionId}/tags/{id} Retrieve a single linked tag
TagResourcesAPI GetCollectionTags Get /api/v2/{collection}/{collectionId}/tags Retrieve a collection of linked tags
TagResourcesAPI GetTag Get /api/v2/tags/{id} Retrieve a single tag
TagResourcesAPI GetTagGroup Get /api/v2/tagGroups/{id} Retrieve a single tag group
TagResourcesAPI GetTagGroupTags Get /api/v2/tagGroups/{collectionId}/tags Retrieve a collection of tags
TagResourcesAPI GetTagGroups Get /api/v2/tagGroups Retrieve a collection of tag groups
TagResourcesAPI GetTagSharedResources Get /api/v2/tags/{collectionId}/sharedResources Retrieve a collection of shared resources
TagResourcesAPI GetTagTaggedResource Get /api/v2/tags/{collectionId}/taggedResources/{id} Retrieve a single tagged resource
TagResourcesAPI GetTagTaggedResources Get /api/v2/tags/{collectionId}/taggedResources Retrieve a collection of tagged resources
TagResourcesAPI GetTagTags Get /api/v2/tags/{collectionId}/tags Retrieve a collection of tags
TagResourcesAPI GetTags Get /api/v2/tags Retrieve a collection of tags
TagResourcesAPI PostCollectionTag Post /api/v2/{collection}/{collectionId}/tags Link a tag to a resource
TagResourcesAPI PostTagGroup Post /api/v2/tagGroups Create a new tag group
TagResourcesAPI PostTagGroupTag Post /api/v2/tagGroups/{collectionId}/tags Create a new tag
TagResourcesAPI PostTagSharedResource Post /api/v2/tags/{collectionId}/sharedResources Create a new shared resource
TagResourcesAPI PostTagTag Post /api/v2/tags/{collectionId}/tags Create a new tag
TagResourcesAPI PostTagTaggedResource Post /api/v2/tags/{collectionId}/taggedResources Create a new tagged resource
TagResourcesAPI PutTag Put /api/v2/tags/{id} Update a tag
TagResourcesAPI PutTagGroup Put /api/v2/tagGroups/{id} Update a tag group
TaskResourcesAPI DeleteUserTask Delete /api/v2/users/{collectionId}/tasks/{id} Delete a task
TaskResourcesAPI GetUserTask Get /api/v2/users/{collectionId}/tasks/{id} Retrieve a single task
TaskResourcesAPI GetUserTasks Get /api/v2/users/{collectionId}/tasks Retrieve a collection of tasks
TaskResourcesAPI PostUserTask Post /api/v2/users/{collectionId}/tasks Create a new task
TaskResourcesAPI PutUserTask Put /api/v2/users/{collectionId}/tasks/{id} Update a task
VendorProfileResourcesAPI DeleteDeploymentOptionDefinition Delete /api/v2/deploymentOptionDefinitions/{id} Delete a deployment option definition
VendorProfileResourcesAPI DeleteVendorProfile Delete /api/v2/vendorProfiles/{id} Delete a vendor profile
VendorProfileResourcesAPI GetCollectionDeploymentOptionDefinitions Get /api/v2/{collection}/{collectionId}/deploymentOptionDefinitions Retrieve a collection of deployment option definitions
VendorProfileResourcesAPI GetDeploymentOptionDefinition Get /api/v2/deploymentOptionDefinitions/{id} Retrieve a single deployment option definition
VendorProfileResourcesAPI GetDeploymentOptionDefinitions Get /api/v2/deploymentOptionDefinitions Retrieve a collection of deployment option definitions
VendorProfileResourcesAPI GetVendorProfile Get /api/v2/vendorProfiles/{id} Retrieve a single vendor profile
VendorProfileResourcesAPI GetVendorProfiles Get /api/v2/vendorProfiles Retrieve a collection of vendor profiles
VendorProfileResourcesAPI PostCollectionDeploymentOptionDefinition Post /api/v2/{collection}/{collectionId}/deploymentOptionDefinitions Create a new deployment option definition
VendorProfileResourcesAPI PostVendorProfile Post /api/v2/vendorProfiles Create a new vendor profile
VendorProfileResourcesAPI PutDeploymentOptionDefinition Put /api/v2/deploymentOptionDefinitions/{id} Update a deployment option definition
VendorProfileResourcesAPI PutVendorProfile Put /api/v2/vendorProfiles/{id} Update a vendor profile
ViewAndZoneResourcesAPI DeleteCollectionAppliedResource Delete /api/v2/{collection}/{collectionId}/appliedResources/{id} Remove a template or policy application from a resource
ViewAndZoneResourcesAPI DeleteCollectionDefaultZone Delete /api/v2/{collection}/{collectionId}/defaultZones/{id} Delete a default zone
ViewAndZoneResourcesAPI DeleteCollectionRestrictedZone Delete /api/v2/{collection}/{collectionId}/restrictedZones/{id} Delete a restricted zone
ViewAndZoneResourcesAPI DeletePolicyItem Delete /api/v2/policyItems/{id} Delete a policy item
ViewAndZoneResourcesAPI DeleteResponsePolicy Delete /api/v2/responsePolicies/{id} Delete a response policy
ViewAndZoneResourcesAPI DeleteTemplate Delete /api/v2/templates/{id} Delete a template
ViewAndZoneResourcesAPI DeleteView Delete /api/v2/views/{id} Delete a view
ViewAndZoneResourcesAPI DeleteZone Delete /api/v2/zones/{id} Delete a zone
ViewAndZoneResourcesAPI GetCollectionAppliedResource Get /api/v2/{collection}/{collectionId}/appliedResources/{id} Retrieve an applied resource
ViewAndZoneResourcesAPI GetCollectionAppliedResources Get /api/v2/{collection}/{collectionId}/appliedResources Retrieve a collection of applied resources
ViewAndZoneResourcesAPI GetCollectionDefaultZone Get /api/v2/{collection}/{collectionId}/defaultZones/{id} Retrieve a single default zone
ViewAndZoneResourcesAPI GetCollectionDefaultZones Get /api/v2/{collection}/{collectionId}/defaultZones Retrieve a collection of default zones
ViewAndZoneResourcesAPI GetCollectionMoves Get /api/v2/{collection}/{collectionId}/moves Retrieve a collection of moves
ViewAndZoneResourcesAPI GetCollectionRestrictedZone Get /api/v2/{collection}/{collectionId}/restrictedZones/{id} Retrieve a single restricted zone
ViewAndZoneResourcesAPI GetCollectionRestrictedZones Get /api/v2/{collection}/{collectionId}/restrictedZones Retrieve a collection of restricted zones
ViewAndZoneResourcesAPI GetCollectionTemplateApplications Get /api/v2/{collection}/{collectionId}/templateApplications Retrieve a collection of template applications
ViewAndZoneResourcesAPI GetCollectionTemplates Get /api/v2/{collection}/{collectionId}/templates Retrieve a collection of templates
ViewAndZoneResourcesAPI GetCollectionZones Get /api/v2/{collection}/{collectionId}/zones Retrieve a collection of zones
ViewAndZoneResourcesAPI GetConfigurationResponsePolicies Get /api/v2/configurations/{collectionId}/responsePolicies Retrieve a collection of response policies
ViewAndZoneResourcesAPI GetConfigurationViews Get /api/v2/configurations/{collectionId}/views Retrieve a collection of views
ViewAndZoneResourcesAPI GetMove Get /api/v2/moves/{id} Retrieve a single move
ViewAndZoneResourcesAPI GetMoves Get /api/v2/moves Retrieve a collection of moves
ViewAndZoneResourcesAPI GetPolicyItem Get /api/v2/policyItems/{id} Retrieve a single policy item
ViewAndZoneResourcesAPI GetPolicyItems Get /api/v2/policyItems Retrieve a collection of policy items
ViewAndZoneResourcesAPI GetResponsePolicies Get /api/v2/responsePolicies Retrieve a collection of response policies
ViewAndZoneResourcesAPI GetResponsePolicy Get /api/v2/responsePolicies/{id} Retrieve a single response policy
ViewAndZoneResourcesAPI GetResponsePolicyPolicyItems Get /api/v2/responsePolicies/{collectionId}/policyItems Retrieve a collection of policy items
ViewAndZoneResourcesAPI GetTemplate Get /api/v2/templates/{id} Retrieve a single template
ViewAndZoneResourcesAPI GetTemplateApplication Get /api/v2/templateApplications/{id} Retrieve a single template application
ViewAndZoneResourcesAPI GetTemplateApplications Get /api/v2/templateApplications Retrieve a collection of template applications
ViewAndZoneResourcesAPI GetTemplates Get /api/v2/templates Retrieve a collection of templates
ViewAndZoneResourcesAPI GetView Get /api/v2/views/{id} Retrieve a single view
ViewAndZoneResourcesAPI GetViews Get /api/v2/views Retrieve a collection of views
ViewAndZoneResourcesAPI GetZone Get /api/v2/zones/{id} Retrieve a single zone
ViewAndZoneResourcesAPI GetZones Get /api/v2/zones Retrieve a collection of zones
ViewAndZoneResourcesAPI PostCollectionAppliedResource Post /api/v2/{collection}/{collectionId}/appliedResources Apply a template or policy to a resource
ViewAndZoneResourcesAPI PostCollectionDefaultZone Post /api/v2/{collection}/{collectionId}/defaultZones Create a new default zone
ViewAndZoneResourcesAPI PostCollectionMove Post /api/v2/{collection}/{collectionId}/moves Create a new move
ViewAndZoneResourcesAPI PostCollectionRestrictedZone Post /api/v2/{collection}/{collectionId}/restrictedZones Create a new restricted zone
ViewAndZoneResourcesAPI PostCollectionTemplate Post /api/v2/{collection}/{collectionId}/templates Create a new template
ViewAndZoneResourcesAPI PostCollectionTemplateApplication Post /api/v2/{collection}/{collectionId}/templateApplications Create a new template application
ViewAndZoneResourcesAPI PostCollectionZone Post /api/v2/{collection}/{collectionId}/zones Create a new zone
ViewAndZoneResourcesAPI PostConfigurationResponsePolicy Post /api/v2/configurations/{collectionId}/responsePolicies Create a new response policy
ViewAndZoneResourcesAPI PostConfigurationView Post /api/v2/configurations/{collectionId}/views Create a new view
ViewAndZoneResourcesAPI PostResponsePolicyPolicyItem Post /api/v2/responsePolicies/{collectionId}/policyItems Create a new policy item
ViewAndZoneResourcesAPI PutPolicyItem Put /api/v2/policyItems/{id} Update a policy item
ViewAndZoneResourcesAPI PutResponsePolicy Put /api/v2/responsePolicies/{id} Update a response policy
ViewAndZoneResourcesAPI PutTemplate Put /api/v2/templates/{id} Update a template
ViewAndZoneResourcesAPI PutView Put /api/v2/views/{id} Update a view
ViewAndZoneResourcesAPI PutZone Put /api/v2/zones/{id} Update a zone

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerToken

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), gobam2.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

basicAuthentication

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), gobam2.ContextBasicAuth, gobam2.BasicAuth{
	UserName: "username",
	Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages