Armory

Armory Network Controller API

The network-controller API from Armory — 2 operation(s) for network-controller.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.armory.io/plugins/scale-agent/
📖
APIReference
https://docs.armory.io/plugins/scale-agent/reference/
📖
GettingStarted
https://docs.armory.io/plugins/scale-agent/install/quickstart/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/authentication/armory-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/openapi/armory-network-controller-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/armory/docs

Other Resources

🔗
Swagger
https://docs.armory.io/reference/scale-agent/swagger.json
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/conventions/armory-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/errors/armory-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/armory/refs/heads/main/data-model/armory-data-model.yml

OpenAPI Specification

armory-network-controller-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Armory Scale Agent Infrastructure Network Controller API
  description: Cloud infrastructure lookups - networks, subnets, VPCs, security groups, elastic IPs, instance types, reservation reports and search.
  version: 0.13.x
  contact:
    name: Armory Docs
    url: https://docs.armory.io/plugins/scale-agent/
  x-origin:
  - format: swagger
    version: '2.0'
    url: https://docs.armory.io/reference/scale-agent/swagger.json
servers:
- url: /
tags:
- name: network-controller
paths:
  /networks:
    get:
      tags:
      - network-controller
      summary: list
      operationId: listUsingGET_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
                additionalProperties:
                  type: array
                  items:
                    $ref: '#/components/schemas/Network'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
  /networks/{cloudProvider}:
    get:
      tags:
      - network-controller
      summary: listByCloudProvider
      operationId: listByCloudProviderUsingGET
      parameters:
      - name: cloudProvider
        in: path
        description: cloudProvider
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Network'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not Found
      deprecated: false
components:
  schemas:
    Network:
      type: object
      properties:
        account:
          type: string
        cloudProvider:
          type: string
        id:
          type: string
        name:
          type: string
        region:
          type: string
      title: Network