NEXTDC Service API

openapi: 3.2.0
info:
  title: Nextdc Service API
  version: '1'
  description: 'Operations tagged service across 2 of this provider''s published API definitions: axon-swagger.json, nextdc-axon-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://sandbox-api.axonvx.com/api/biz2
tags:
- name: Service
paths:
  /v1/service/{service_guid}:
    get:
      operationId: bizApiServiceServiceBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Get a single service 🔐
      description: 'Obtain details for a single service.

        NOTE: Do not loop over this API endpoint to read multiple services.

        NOTE: Only dynamic information is returned. Static metadata information needs to be cached at allocation.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
    servers:
    - url: https://sandbox-api.axonvx.com/api/biz2
  /v1/service/exc/{service_guid}/{diverse_service_guid}/INFO/DIVERSE:
    get:
      operationId: bizApiServiceIsDiverseBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      - name: diverse_service_guid
        description: Diverse service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Is service diverse to another? 🔐
      description: Given two service GUID's determine if the services are totally diverse. All unprotected components are checked.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
    put:
      operationId: bizApiServiceServiceUpdateDiversityBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      - name: diverse_service_guid
        description: Diverse service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Update a services diversity 🔐
      description: Given two service GUID's, and the services are totally diverse, then update the services $diverse_service_guid. If the services are not diverse no change is made.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
    servers:
    - url: https://sandbox-api.axonvx.com/api/biz2
  /v1/service/exc/{company_id}:
    post:
      operationId: bizApiServiceServiceCreateBiz
      tags:
      - Service
      parameters:
      - name: company_id
        description: Company ID
        in: path
        required: true
        schema:
          type: string
      summary: Create an EXC service from a service definition 🔐
      description: Use the candidate_service_id obtained by the GET /service call to request and queue the creation of a new EXC. Some service types will require additional fields. For eg. the microsoft service type requires an skey, a port to port service will require a remote_vlan. These can be added to the product options.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bizApiServiceServiceCreateBizModel'
        description: "**candidate_service_guid** (required)  \n**product_options** (required)  \npurchase_order  \ndocument_ids  \n"
        required: true
    servers:
    - url: https://sandbox-api.axonvx.com/api/biz2
  /v1/service/exc/{service_guid}:
    put:
      operationId: bizApiServiceServiceUpdateBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Update an EXC service definition 🔐
      description: Modify service parameters. Returns "HTTP 202 Accepted" if operations manual intervention is required.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bizApiServiceServiceUpdateBizModel'
        description: "description  \nouter_vlan  \nbandwidth_cir  \npurchase_order  \ndocument_ids  \n"
    delete:
      operationId: bizApiServiceRemoveServiceBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Delete an EXC service definition 🔐
      description: Delete a service. Returns "HTTP 202 Accepted" if operations manual intervention is required.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
    servers:
    - url: https://sandbox-api.axonvx.com/api/biz2
  /v1/service/exc/{service_guid}/APPROVAL:
    put:
      operationId: bizApiServiceApproveBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Approve an incoming EXC on a port that you administer 🔐
      description: Approve or reject an EXC that has been configured to a port that is within your control.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bizApiServiceApproveBizModel'
        description: "**approve** (required)  \nvlan  \n"
        required: true
    servers:
    - url: https://sandbox-api.axonvx.com/api/biz2
  /v1/service/exc/{service_guid}/INFO/DIVERSE:
    delete:
      operationId: bizApiServiceServiceDeleteDiversityBiz
      tags:
      - Service
      parameters:
      - name: service_guid
        description: Service GUID
        in: path
        required: true
        schema:
          type: string
      summary: Delete a services diversity 🔐
      description: Removes a services diversity setting.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
      security:
      - api_key: []
    servers:
    - url: https://sandbox-api.axonvx.com/api/biz2
components:
  schemas:
    mixed:
      properties:
        description:
          type: string
          description: $description Resource description. Used as a reference for billing records (must be unique)
      required:
      - description
    bizApiServiceServiceCreateBizModel:
      properties:
        candidate_service_guid:
          type: string
          description: Candidate Service GUID
        product_options:
          $ref: '#/components/schemas/mixed'
          description: Product Options
        purchase_order:
          type: string
          description: PO Number for account reconciliation (optional)
          maximum: 100
        document_ids:
          type: array
          items:
            type: string
          description: Document ID string. Providing this string will record the current session data as a signature on the document
      required:
      - candidate_service_guid
      - product_options
    bizApiServiceServiceUpdateBizModel:
      properties:
        description:
          type: string
          description: Service Description (optional)
          maximum: 200
        outer_vlan:
          type: integer
          format: int64
          description: Outer VLAN (optional)
        bandwidth_cir:
          type: integer
          format: int64
          description: Bandwidth (optional)
        purchase_order:
          type: string
          description: PO Number for account reconciliation (optional)
          maximum: 100
        document_ids:
          type: array
          items:
            type: string
          description: Document ID string. Providing this string will record the current session data as a signature on the document
    bizApiServiceApproveBizModel:
      properties:
        approve:
          type: boolean
          description: TRUE - Approve connection FALSE - reject EXC
        vlan:
          type: integer
          format: int64
          description: Negotiated VLAN for the B end
      required:
      - approve
  securitySchemes:
    api_key:
      type: apiKey
      name: api_key
      in: query
x-refined-from:
- axon-swagger.json
- nextdc-axon-openapi.yml