@itentialopensource/adapter-ns1_cloud/report/adapter-openapi.yaml

This adapter integrates with system described as: ns1_cloud.

openapi: 3.1.0
info:
  title: NS1_CLOUD
  description: >
    This is the documentation for NS1's API (v1), which allows you to manage your zones and records, data sources and feeds, account settings and users, and other aspects of your NS1 account. The NS1 API is a standard REST API with JSON responses. The HTTP method you use — `GET`, `PUT`, `POST`, or `DELETE` — determines the kind of action to be taken by the API. In the case of PUT and POST requests, you will generally send us a JSON body in your request with the details of the resource you're creating or updating. Most API requests are authenticated with a simple API Key, which you must specify in the **X-NSONE-Key** request header. You can manage your API Keys in the Managed DNS portal (**my.nsone.net**) or within your Private DNS/DDI portal. You should treat your API Keys as secrets. You should also give them only the minimal access needed for your application.
  contact:
    email: support@itential.com
  version: '1.0.0'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: https://api.nsone.net/v1/
  variables: {}
paths:
  /zones:
    get:
      tags:
      - Zones
      summary: Viewalistofactivezones
      description: "Returns all active zones and basic zone configuration details for each. \n\n**Note**: For users with over 2500 zones, the response will be paginated to 2500 zones per page. To access the following zones, request the link in the **Link** response header, this follows the Web Linking standard (RFC 5988)\n"
      operationId: Viewalistofactivezones
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Zone'
                description: successful operation
                contentMediaType: application/json
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /zones/{zone}:
    get:
      tags:
      - Zones
      summary: Viewzonedetails
      description: >
        Returns a single active zone and its basic configuration details. For convenience, a list of records in the zone, and some basic details of each record, is also included.


        Note: For zones with over 2500 records, the response will be paginated to 2500 records per page. To access the following records, request the link in the Link response header, this follows the Web Linking standard (RFC 5988)
      operationId: Viewzonedetails
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Zone'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Zones
      summary: Modifyazone
      description: >
        Modifies the basic details of a DNS zone. You must include a JSON body in the request, in which you may include ttl (SOA record TTL), refresh, retry, expiry, or nx_ttl values, as in a SOA record. You may not change the zone name or other details.


        If you are modifying a secondary zone, you can change the primary_ip and primary_port. You can also change enabled in the secondary object to convert a zone between primary and secondary behavior. Note that when converting a secondary to a primary zone, you must create a NS record for the zone with the assigned NSONE nameservers.


        You can enable or disable replication from the primary zone, as well as add or remove secondary (replica) hosts by manipulating the primary object.


        You may modify the set of DNS networks for which the zone should be made available. Note that if you remove a network from a zone, and later re-add it, then new nameservers will be assigned within that network. You may remove all networks from a zone, in which case the zone will not be accessible from any DNS network.
      operationId: Modifyazone
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: DNS Zone Object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Zone'
              - description: DNS Zone Object
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Zone'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Zones
      summary: Createanewzone
      description: "You must include a JSON body in the request with basic details of the zone. The only required element in the body is zone, the zone domain name. You can create a standard zone (which has its own configuration and records), a linked zone (pointing to an existing standard zone, reusing its configuration and records), or a secondary zone (which replicates DNS records from an external primary DNS server). For non-linked zones, you may specify optional zone configuration by including ttl (SOA record TTL), refresh, retry, expiry, and nx_ttl values, as in a SOA record. The zone is assigned DNS servers and appropriate NS records are automatically created, unless you create a secondary zone.\n\n  To create a linked zone, you must include a link property in the body of your request. It must be a string which references the target zone (domain name) to link to. The target zone must be owned by the same account that is creating the linked zone. If the linkproperty is specified, no other zone configuration properties (such as refresh, retry, etc) may be specified, since they are all pulled from the target zone. Linked zones, once created, cannot be configured at all and cannot have records added to them. They may only be deleted, which does not affect the target zone at all.\n  \n  To create a secondary zone, you must include a secondary object in the body of your request including fields enabled (true/false, if true the zone is configured as a secondary zone); and primary_ip(an IPv4 address, not a hostname, for the primary DNS server for the zone). If your primary DNS server is running on a non-standard port, you may also include primary_port.\n  \n  To enable zone replication by third-party DNS servers, you must include a primary object in the body of your request including fields enabled (true/false, if true then AXFR queries and optionally NOTIFY messages will be enabled for the zone); and secondaries, a list of objects each containing ip (IPv4 address of the secondary node), port (optional, port on host to send NOTIFYmessages, default 53), and notify (true/false, if true then we will send NOTIFY messages to the secondary host when the zone changes).\n  \n  If your account has access to multiple DNS networks, you may pass in networks, a list of network ids for which the zone should be made available. If you do not provide a list of networks, the zone will be created in network 0, the primary NSONE Global Network. DNS servers will be selected and assigned from among all the networks you specify.\n"
      operationId: Createanewzone
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: DNS Zone Object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Zone'
              - description: DNS Zone Object
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Zone'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Zones
      summary: Deleteazone&allassociatedrecords
      description: >
        Deletes an existing DNS zone and all of its associated records.


        Note: NS1 servers will not respond to queries for the zone or any of the records after it is deleted, and you cannot recover the deleted zone. There is no request body required, and there is no response other than the HTTP status code.
      operationId: Deleteazone&allassociatedrecords
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /zones/{zone}/dnssec:
    get:
      tags:
      - Zones
      summary: ViewDNSSECdetailsforazone
      description: Returns public key information including DNSKEY and DS record information.
      operationId: ViewDNSSECdetailsforazone
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: public key information including DNSKEY and DS record information.
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: public key information including DNSKEY and DS record information.
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /import/zonefile/{zone}:
    get:
      tags:
      - Zones
      summary: Viewstatusofzonefileimport
      description: >
        Get the status, and if finished, results of, a zone file import job launched with a PUT request to /import/zonefile/:zone. The jobid is the value of the id field in the response of an asynchronous import request. If the zone file import is finished, the response includes the fields response (body containing import request results), and response_code (final HTTP status code for the import request).
      operationId: Viewstatusofzonefileimport
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: Import Job ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: successful operation
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Zones
      summary: Importazonefromazonefile
      description: >
        Upload a zone file, using form encoding (multipart/form-data) with the zone file as the content of the zonefile form parameter. The zone must not already exist in your account. It will be created, as will all records in the zone file. Any round-robin records (e.g., multiple A records for the same domain) will be treated as answers for a single combined record in your account. Existing NS records will be replaced, as will some details of SOA records.


        There are two modes: synchronous (default) and asynchronous. In asynchronous mode, you must check back with a GET request using the returned job id to get the results of your request. In synchronous mode, the connection remains open until the results can be returned to you directly. Full details of the new zone and all records are returned; a warnings field contains a list of strings with any warnings from the zone file import process.


        Upon import, the zone will be made available only on the NSONE Global Network (network 0). If your account has access to other DNS networks and you wish to make the zone available via those networks, simply add them to the zone after importing the zone file.
      operationId: Importazonefromazonefile
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      - name: async
        in: query
        description: Run Asynchronously
        style: form
        explode: true
        schema:
          type: boolean
      requestBody:
        content:
          multipart/form-data:
            encoding: {}
            schema:
              type: object
              properties:
                zoneFile:
                  type: string
                  description: DNS Zone File
                  contentEncoding: base64
              contentMediaType: multipart/form-data
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Zone'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /search:
    get:
      tags:
      - Zones
      summary: Searchzonesandrecords
      description: Returns all zones and records that match a query string q. You can limit the max number of results and you can restrict the type of results to zone, record, or all. Entries in the response without domain/type are zones, and those with domain/type are records.
      operationId: Searchzonesandrecords
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: q
        in: query
        description: Query Parameters
        style: form
        explode: true
        schema:
          type: string
      - name: max
        in: query
        description: Max Number of Results
        style: form
        explode: true
        schema:
          type: integer
          contentEncoding: int32
      - name: type
        in: query
        description: Type of Results
        style: form
        explode: true
        schema:
          allOf:
          - $ref: '#/components/schemas/type'
          - description: Type of Results
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Zone'
                description: successful operation
                contentMediaType: application/json
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /networks:
    get:
      tags:
      - Zones
      summary: Listavailablenetworks
      description: Some customers may have access to DNS networks other than the primary NSONE Global Network. This endpoint lists all networks for which you may create zones and records. You will generally always have access to the NSONE Global Network (network 0).
      operationId: Listavailablenetworks
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Network'
                description: successful operation
                contentMediaType: application/json
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /zones/{zone}/{domain}/{type}:
    get:
      tags:
      - Records
      summary: Viewrecordconfigurationdetails
      description: >
        Returns full configuration for a DNS record including basic config, answers, regions, filter chain configuration, and all metadata tables and data feeds attached to entities in the record. (Note that regions might be any specified grouping, not necessarily a geo-related region. For this reason, the NS1 web portal at my.nsone.net uses the word "group" instead of "region".)


        You must fully specify zone, domain, and record type, e.g., example.com/www.example.com/A returns the A record for www.example.com in the example.com zone.
      operationId: Viewrecordconfigurationdetails
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      - name: domain
        in: path
        description: DNS Domain Name
        required: true
        style: simple
        schema:
          type: string
      - name: type
        in: path
        description: DNS Record Type
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSRecord'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Records
      summary: Updaterecordconfiguration
      description: Modifies configuration details for an existing DNS record.
      operationId: Updaterecordconfiguration
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      - name: domain
        in: path
        description: DNS Domain Name
        required: true
        style: simple
        schema:
          type: string
      - name: type
        in: path
        description: DNS Record Type
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: DNS Record Configuration Parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DNSRecord'
              - description: DNS Record Configuration Parameters
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSRecord'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Records
      summary: CreateanewDNSrecord
      description: "Creates a new DNS record in the specified zone, for the specified domain, of the given record type. Currently supported record types are: A, AAAA, ALIAS, AFSDB, CERT, CNAME, DNAME, HINFO, MX, NAPTR, NS, PTR, RP, SPF, SRV, TXT. The answer field within each entry in the answers list must be a list of the RDATA fields for a DNS record of the specified type.\n\n  You may not create multiple records of the same type for the same domain name in a zone — instead, add new answers to the existing record. The default behavior if no filters are in the filter chain is to return all answers matching a query.\n  \n  Metadata tables (meta) may be specified in answers, in regions or in the record as a whole. (Note that regions can be any kind of group, not just geo-related. For this reason, the NS1 web portal at my.nsone.net uses the word \"group\" instead of \"region\".) The metadata tables may contain key/value pairs where valid keys and values are as described in the output of /metatypes.\n  \n  Anywhere metadata tables can go, data feeds can go as well. Connect a compatible feed to a metadata key by assigning its value to be a JSON object pointing to the data feed that should be consulted for the final value.\n  \n  The new record will take on the same networks as the zone it's in.\n  \n  Instead of specifying answers and other details, you may create a \"linked\" record. This allows you reuse the configuration (including answers and metadata) from an existing record in NSONE's systems. Linked records will respond in the exact same way as their targets at DNS resolution time, and can be used for maintaining complicated record configurations in a single record while pointing (linking) other lightweight records to it. Linked records must point to another record of the exact same record type and do not have to exist in the same zone.\n  \n  To create a linked record, specify the link property as a string whose contents is the FQDN containing the config it should link to. If link is specified, no other record configuration (such as answersor meta) should be specified.\n"
      operationId: CreateanewDNSrecord
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      - name: domain
        in: path
        description: DNS Domain Name
        required: true
        style: simple
        schema:
          type: string
      - name: type
        in: path
        description: DNS Record Type
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Record Creation Parameters
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DNSRecord'
              - description: Record Creation Parameters
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DNSRecord'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Records
      summary: Deletearecord
      description: >
        Removes an existing record and all associated answers and configuration details. We will no longer respond for this record once it is deleted, and it cannot be recovered, so use caution. Note: This operation deletes all answers associated with the domain and record type. If you want to delete individual answers, do a POSToperation to update the record's answers list. This method has no response other than the HTTP status code.
      operationId: Deletearecord
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: zone
        in: path
        description: DNS Zone Name
        required: true
        style: simple
        schema:
          type: string
      - name: domain
        in: path
        description: DNS Domain Name
        required: true
        style: simple
        schema:
          type: string
      - name: type
        in: path
        description: DNS Record Type
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /metatypes:
    get:
      tags:
      - Records
      summary: Viewavailablemetadata
      description: Returns a list of available metadata fields for use in configuring records, including descriptions (in HTML).
      operationId: Viewavailablemetadata
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: successful operation
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /filtertypes:
    get:
      tags:
      - Records
      summary: Viewavailablefilters
      description: Returns a list of available FILTERS for use in configuring dynamic records, including descriptions (in HTML), configuration options, and metadata inputs used by the filter, along with any restrictions on record types where the filter may be used.
      operationId: Viewavailablefilters
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: successful operation
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /metatypes/geo:
    get:
      tags:
      - Records
      summary: Viewavailablegeographicmetadata
      description: Returns a list of available geographic metadata used by the “Geo-target Country” and “Geo-fence Country” filters . Note that the response will be long. The example response below is truncated for readability.
      operationId: Viewavailablegeographicmetadata
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: successful operation
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /data/sourcetypes:
    get:
      tags:
      - Data Sources
      summary: Viewavailabledatasourcestypes
      description: Returns a list of all available data source types. For any third party data sources, you must have an account with the provider. Frequently, there are additional steps you must take with the provider to connect your data source — these are explained in the desc field which is HTML. Response includes any config options for the data source, required or optional; and any feed_config options for data feeds connected to the source.
      operationId: Viewavailabledatasourcestypes
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: successful operation
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /data/sources:
    get:
      tags:
      - Data Sources
      summary: Viewactivedatasources
      description: Returns a list of all connected data sources, and for each data source, all connected feeds including connected metadata table destinations.
      operationId: Viewactivedatasources
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataSource'
                description: successful operation
                contentMediaType: application/json
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Data Sources
      summary: Connectanewdatasource
      description: Creates a new data source. You may create multiple data sources of the same type, e.g., to correspond to different accounts with a data provider. The config for the source must contain fields corresponding to the config description in /data/sourcetypes for the sourcetype you specify. Some data sources are immediately connected; others enter a pending state awaiting activity from the data source, e.g., a verification request. See the documentation for the source from /data/sourcetypes.
      operationId: Connectanewdatasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: config
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/config'
              - description: config
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /data/sources/{sourceid}:
    get:
      tags:
      - Data Sources
      summary: Viewasingledatasource
      description: Returns the details for a single data source, including configuration, all connected data feeds, and within data feeds, any connected metadata table (destinations).
      operationId: Viewasingledatasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Data Sources
      summary: Modifyadatasource
      description: Modifies basic details or configuration of a data source. You must include a JSON body in the request. You may update name and config details.
      operationId: Modifyadatasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Data Source Configuration
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DataSource'
              - description: Data Source Configuration
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataSource'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Data Sources
      summary: Deleteadatasource
      description: Removes an existing data source and all connected feeds from the source. By extension, all metadata tables connected to those feeds will no longer receive updates. We will no longer accept updates on the Feed URL for this data source. This method has no response other than the HTTP status code.
      operationId: Deleteadatasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /data/feeds/{sourceid}:
    get:
      tags:
      - Data Feeds
      summary: Viewactivedatafeedsforasource
      description: Returns all data feeds connected to a source. Includes config details for each feed which match the feed_config specification from /data/sourcetypes, and also includes a list of metadata tables that are destinations for each feed.
      operationId: Viewactivedatafeedsforasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/DataFeed'
                description: successful operation
                contentMediaType: application/json
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Data Feeds
      summary: Publishdatafromadatasource
      description: >
        This is the Feed URL for a data source. Many data sources connect directly to this URL to feed data to NSONE, and in general you must configure them to do so according to the instructions for the data source (see /data/sourcetypes). The request sent to this URL depends on the type of the data source — usually, each data source has its own request protocol. For convenience, this URL accepts GET, PUT, and POST requests, but POST is preferred.


        You can feed data to the Feed URL directly for your NSONE API data sources (sourcetype of nsone_v1), as shown in the example.


        Updates sent to the Feed URL that match any data feeds connected to the data source are applied to all destinations in the feeds and pushed out to our DNS network instantly.
      operationId: Publishdatafromadatasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: update
        content:
          text/plain:
            schema:
              type: object
              description: update
              contentMediaType: text/plain
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            text/plain:
              schema:
                type: object
                description: successful operation
                contentMediaType: text/plain
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Data Feeds
      summary: Connectanewdatafeedtoadatasource
      description: Given an existing data source, connects a new data feed to the source with a given (freeform) name and config matching the specification in feed_config from /data/sourcetypes. In this example, we connect a Rackspace Cloud Monitoring Alarm (using the Rackspace Alarm id and Entity id for the Alarm). To subsequently connect the feed to destinations (such as record answers), you should modify the record to connect a specific metadata key (which the feed is compatible with) via a feed pointer object to this feed id. See the documention for /zones/:zone/:domain/:type.
      operationId: Connectanewdatafeedtoadatasource
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Data Feed Object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DataFeed'
              - description: Data Feed Object
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFeed'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /data/feeds/{sourceid}/{feedid}:
    get:
      tags:
      - Data Feeds
      summary: Viewdatafeeddetails
      description: Returns the details of a single data feed, including config details and any record, region, or answer metadata table destinations.
      operationId: Viewdatafeeddetails
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      - name: feedid
        in: path
        description: Data Feed ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFeed'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Data Feeds
      summary: Modifyadatafeed
      description: >
        You may update name or config.


        To connect the feed to destinations (such as record answers), you should instead modify the record to connect a specific metadata key (which the feed is compatible with) via a feed pointer object to this feed id. See the documention for /zones/:zone/:domain/:type.
      operationId: Modifyadatafeed
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      - name: feedid
        in: path
        description: Data Feed ID
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Data Feed Object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/DataFeed'
              - description: Data Feed Object
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataFeed'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Data Feeds
      summary: Disconnectadatafeed
      description: The feed will be disconnected from the data source and all attached destination metadata tables. The data source will not be removed and updates to remaining connected data feeds will still be processed.
      operationId: Disconnectadatafeed
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: sourceid
        in: path
        description: Data Source ID
        required: true
        style: simple
        schema:
          type: string
      - name: feedid
        in: path
        description: Data Feed ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content: {}
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /monitoring/jobs:
    get:
      tags:
      - Monitoring Jobs
      summary: Listmonitoringjobs
      description: Returns the list of all monitoring jobs for the account, including configuration and current status details. Job status is shown per region, including the "global" region indicating the overal status of the monitoring job computed based on the status policy from the regional statuses. Status values both globally and per region include up, down, and pending.
      operationId: Listmonitoringjobs
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Job'
                description: successful operation
                contentMediaType: application/json
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    put:
      tags:
      - Monitoring Jobs
      summary: Createanewmonitoringjob
      description: Create a new monitoring job
      operationId: Createanewmonitoringjob
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Monitoring Job Object
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/Job'
              - description: Monitoring Job Object
              contentMediaType: application/json
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    parameters: []
  /monitoring/jobs/{jobid}:
    get:
      tags:
      - Monitoring Jobs
      summary: Viewmonitoringjobdetails
      description: Returns details for a specific monitoring jobs based on its id, including configuration and current status details. Job status is shown per region, including the "global" region indicating the overal status of the monitoring job computed based on the status policyfrom the regional statuses. Status values both globally and per region include up, down, and pending.
      operationId: Viewmonitoringjobdetails
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: jobid
        in: path
        description: Monitoring Job ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    post:
      tags:
      - Monitoring Jobs
      summary: Updatedetailsofamonitoringjob
      description: Change the configuration details of an existing monitoring job. See the documentation for PUT /monitoring/jobs for a detailed explanation of the input.
      operationId: Updatedetailsofamonitoringjob
      parameters:
      - name: X-NSONE-Key
        in: header
        description: ''
        required: true
        style: simple
        schema:
          type: string
      - name: jobid
        in: path
        description: Monitoring Job ID
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Monitoring Job Object
        content:
          text/plain:
            schema:
              type: string
              description: Monitoring Job Object
              contentMediaType: text/plain
        required: false
      responses:
        '200':
          description: successful operation
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Job'
        '400':
          description: failed operation
          headers: {}
          content: {}
      deprecated: false
    delete:
      tags:
      - Monitoring Jobs
      summary: Removeamonitoringjob
      description: Immediately terminates and deletes an existing monitoring job. There is no response other than the HTTP status code.
      operationId: Removeamonitoringjob
      parameters:
      - name: jobid
        in: path
        description: Monitoring Job ID
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: s