Domains Web Service

The API provides the domains web service to let you view, create, and modify IP domain definitions.
You can view, create, and modify IP domain definitions using the
domains
web service. Managed items are associated with IP domains by the data sources during data collection. Consult the documentation for each registered data source to determine the steps to take to associate items with domains.
In this article:
Verify the Prerequisites
  • You have connected the REST client that you will use to invoke the PC web services to the PC RESTful web services.
  • You are a local admin user.
Access the domains Web Service Documentation
As a local admin user, issue the following call to see the parameters for the
domains
web service:
http://
PC_host
:8181/pc/center/webservice/domains
As a local admin user, issue the following call to see a list of supported operations:
http://
PC_host
:8181/pc/center/rest/domains/documentation
Available GET Methods
  • get list
    Gets a list of all of the IP domains that belong to the tenant for the logged-in user.
    Run the
    getList
    method to the root
    /domains/
    to retrieve a list of all IP domain IDs for the tenant of the currently logged-in administrator:
    • If you are logged in as a global administrator, you see a list of domain IDs for the Default Tenant only.
    • If you are logged in as a tenant administrator, you see a list of domain IDs for your tenant.
  • get
    Retrieves information about a specified IP domain:
    http://
    PC_host
    :8181/pc/center/webservice/domains/idName/idValue
    The administrator sees only the IP domains that fall within the Default Tenant. A tenant administrator sees only the IP domains within that tenant.
  • get domain for group
    Gets the IP domain associated with a specified group:
    http://
    PC_host
    :8181/pc/center/webservice/domains/group/groupIdName/groupIdValue
  • get id names
    Retrieves a list of identifiers that can be used to identify IP domains in other web service operations:
    http://
    PC_host
    :8181/pc/center/webservice/domains/idNames
  • get list
    Gets all of the IP domains that belong to the tenant for the logged-in user:
    http://
    PC_host
    :8181/pc/center/webservice/domains
  • get list by tenant
    Retrieves the list of all of the IP domains that are associated with the specified tenant ID:
    http://
    PC_host
    :8181/pc/center/webservice/domains/tenantItemId/tenantId
  • get list with translation
    Gets all of the IP domains that belong to the tenant for the logged-in user. Any localized text is translated to the specified language:
    http://
    PC_host
    :8181/pc/center/webservice/domains/cultureId
Available POST Method
  • create
    Creates an IP domain:
    http://
    PC_host
    :8181/pc/center/webservice/domains
Available PUT Method
  • update
    Updates a specified IP domain.
    http://
    PC_host
    :8181/pc/center/webservice/domains/idName/idValue
Available DELETE Method
  • delete
    Deletes an IP domain definition.
    http://
    PC_host
    :8181/pc/center/webservice/domains/
    {idName}
    /
    {idValue}
Basic IP Domain Parameters
The current values for the following domain parameters are available from the GET command:
  • cultureID
    Specifies a language (locale). Supply a language identifier from the following list:
    • en-US (English, United States)
    • ja-JP (Japanese)
    • zh-CN (Simplified Chinese)
    • fr-FR (French, France)
  • dnsProxyAddress
    Is the IP address of the DNS proxy server.
  • domainItemID
    Is an internal (database) identifier for a tenant definition.
  • groupItemID
    Is an internal (database) identifier for the group definition associated with a domain.
  • itemDesc
    Describes this domain namespace, such as naming the enterprise that owns it.
  • itemName
    Identifies the domain.
    tenantIDIs an internal (database) identifier for a tenant definition. Identifies the tenant associated with this domain.
  • primaryDNSAddress
    Is the IP address of the primary name server for this domain.
  • primaryDNSPort
    Is the port number that the primary name server uses.
  • secondaryDNSAddress
    (Optional) Is the IP address of the secondary name server for this domain.
  • secondaryDNSPort
    (Optional) Is the port number that the secondary name server uses.
  • isDNSProxyEnabled
    Indicates whether the proxy address is enabled for this IP domain.
  • deviceAlias
    Indicates the alias to use for a managed item. A device alias is a user-configured name that is applied to the associated managed item in
    NetOps Portal
    .
  • deviceAliasList
    Identifies a CSV or TXT file of alternate interface descriptions. A comma-separated list of values that include the device IP address, interface name, interface description, and alternate interface description (alias) mappings.
  • interfaceDescriptionOverride
    Indicates the alternate description to use for an interface. Overrides the interface descriptions that appear in
    NetOps Portal
    by default.