Cisco Hardware Sites API

The Sites API from Cisco Hardware — 1 operation(s) for sites.

OpenAPI Specification

cisco-hardware-sites-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Cisco Catalyst Center (DNA Center) Intent Authentication Sites API
  description: 'The Cisco Catalyst Center (formerly DNA Center) Intent API provides

    programmatic management of Cisco enterprise network hardware, including

    discovery, inventory, provisioning, assurance, software image

    management, sites, and command runner. Authentication uses a basic-auth

    token exchange against /dna/system/api/v1/auth/token; the returned

    token is sent on subsequent requests as the X-Auth-Token header.

    '
  version: 1.0.0
  contact:
    name: Cisco DevNet
    url: https://developer.cisco.com/docs/dna-center/
servers:
- url: https://{controllerHost}
  variables:
    controllerHost:
      default: sandboxdnac.cisco.com
      description: Host of the Catalyst Center controller
security:
- tokenAuth: []
tags:
- name: Sites
paths:
  /dna/intent/api/v1/site:
    get:
      tags:
      - Sites
      summary: Get site
      operationId: getSite
      parameters:
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: siteId
        schema:
          type: string
      - in: query
        name: type
        schema:
          type: string
          enum:
          - area
          - building
          - floor
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: offset
        schema:
          type: integer
      responses:
        '200':
          description: Sites
    post:
      tags:
      - Sites
      summary: Create site
      operationId: createSite
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                  - area
                  - building
                  - floor
                site:
                  type: object
      responses:
        '202':
          description: Task accepted
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    tokenAuth:
      type: apiKey
      in: header
      name: X-Auth-Token