Jinja2 configuration templates and their declared variables.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/pica8:pica8-template-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Pica8 AmpCon Network Controller Template API
version: 1.12.1
summary: JSON REST API of the customer-deployed Pica8 AmpCon network controller.
description: Machine-readable transcription of the REST API that Pica8 publishes for its AmpCon Network Controller.
contact:
name: Pica8 Support
url: https://www.pica8.com/support/
x-provenance:
method: derived
derived-by: API Evangelist enrichment pipeline
derived-on: '2026-08-26'
derived-from: 'https://pica8-fs.atlassian.net/wiki/spaces/ampcon/pages/753668/AmpCon+API+document (attachment: AmpCon 1.12.0 API document 20230625.docx, AmpCon version 1.12.1, update time 2023/06/25)'
first-party: false
verbatim: false
note: Transcribed from the provider's published prose/Word API reference. Not published by Pica8 as OpenAPI.
x-documentation-gaps:
- operation: Upgrade switch (section 4.11)
gap: The URL in the published document is truncated to `https://<ampcon-server-ip>/api/` and the HTTP method field is blank. Content-Type is multipart/form-data and the input is `[sn, files]`. The path was NOT guessed and the operation is therefore absent from paths[].
- operation: Group schedule upgrade (section 4.18)
gap: The URL in the published document is truncated to `https://<ampcon-server-ip>/api/`. Method POST, Content-Type multipart/form-data, input `[name, start_date, end_date, files]`. Path not guessed; operation absent from paths[].
- operation: Run playbook (section 6.4)
gap: The URL in the published document is truncated to `https://<ampcon-server-ip>/api/`. Method POST, Content-Type application/json, input includes playbook_name, playbook_dir, switches[], switch_checkall, group_list[], vars and a scheduled object with type DIRECT|ONCE|SCHEDULED. Path not guessed; operation absent from paths[].
- operation: Get configuration file by name (section 3.4.2)
gap: The published document gives the same URL (`/api/config_files`) for both the list and the filter-by-name variant, with no name parameter. Only the list form is described here.
- operation: Delete group (section 4.17)
gap: The published document assigns `POST /api/switch/groups/update` to BOTH group update and group delete. Modelled as a single overloaded operation.
- operation: Update AmpCon login user (section 5.3)
gap: The published document records the method as GET while also specifying a JSON request body. Transcribed as documented.
servers:
- url: https://{ampcon-server-ip}
description: Customer-deployed AmpCon Network Controller. Written `https://<ampcon-server-ip>/` in the source document.
variables:
ampcon-server-ip:
default: ampcon.example.internal
description: Address of the operator's own AmpCon server.
security:
- bearerAuth: []
tags:
- name: Template
description: Jinja2 configuration templates and their declared variables.
paths:
/api/templates:
get:
operationId: getTemplates
summary: Get templates list
description: Returns every configuration template on the AmpCon server, including its Jinja2 body, declared parameters, target platform and tag.
tags:
- Template
responses:
'200':
description: Template list.
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
content:
type: string
j2_template:
type: string
tag:
type: string
params:
type: string
platform:
type: string
/api/templates/{template_name}:
get:
operationId: getTemplateByName
summary: Get template information by name
description: Returns a single configuration template filtered by name.
tags:
- Template
responses:
'200':
description: Template.
content:
application/json:
schema:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
content:
type: string
j2_template:
type: string
tag:
type: string
params:
type: string
platform:
type: string
parameters:
- name: template_name
in: path
required: true
schema:
type: string
description: Template name.
/api/templates/add:
post:
operationId: addTemplate
summary: Add new template
description: Creates a new configuration template. Fails when the hardware model named in `platform` has not been configured on the controller, or when a template of the same name already exists.
tags:
- Template
responses:
'200':
description: Success. AmpCon returns a message plus a status/status_code field in the body; the HTTP status line is not the primary error signal.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
status_code:
type: integer
status:
type: integer
info:
type: string
message:
type: string
example:
msg: success
status_code: 200
'500':
description: Documented error response. AmpCon reports the failure in the body (`status` / `status_code` of 400 or 500) alongside a human-readable message.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
status_code:
type: integer
status:
type: integer
info:
type: string
message:
type: string
example:
msg: Template <name> exists
status_code: 500
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
platform:
type: string
content:
type: string
description:
type: string
action:
type: string
enum:
- Config
- Delete
required:
- name
- platform
- content
example:
name: <template-name>
platform: <platform-name>
content: <jinja2-template-string>
description: <template-desc>
action: Config
/api/templates/update:
post:
operationId: updateTemplate
summary: Update template
description: 'Updates an existing template. `type` selects what is being replaced: `template_var` rewrites the variable definitions (default, type, description, param_check), `j2_template` rewrites the Jinja2 body.'
tags:
- Template
responses:
'200':
description: Success. AmpCon returns a message plus a status/status_code field in the body; the HTTP status line is not the primary error signal.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
status_code:
type: integer
status:
type: integer
info:
type: string
message:
type: string
example:
msg: success
status_code: 200
'500':
description: Documented error response. AmpCon reports the failure in the body (`status` / `status_code` of 400 or 500) alongside a human-readable message.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
status_code:
type: integer
status:
type: integer
info:
type: string
message:
type: string
example:
msg: template_name <name> does not exist
status_code: 500
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
file_name:
type: string
content: {}
type:
type: string
enum:
- template_var
- j2_template
required:
- file_name
- content
- type
example:
file_name: <template-name>
content: <jinja2-template-string>
type: j2_template
/api/templates/delete:
post:
operationId: deleteTemplate
summary: Delete template
description: Deletes an existing template by name.
tags:
- Template
responses:
'200':
description: Success. AmpCon returns a message plus a status/status_code field in the body; the HTTP status line is not the primary error signal.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
status_code:
type: integer
status:
type: integer
info:
type: string
message:
type: string
example:
msg: success
status_code: 200
'500':
description: Documented error response. AmpCon reports the failure in the body (`status` / `status_code` of 400 or 500) alongside a human-readable message.
content:
application/json:
schema:
type: object
properties:
msg:
type: string
status_code:
type: integer
status:
type: integer
info:
type: string
message:
type: string
example:
msg: template_name <name> does not exist
status_code: 500
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
required:
- name
example:
name: <template-name>
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'JWT minted by POST /token from AmpCon web login credentials. Only `superadmin` level users may mint a token. Sent as `Authorization: Bearer <token>`. An expired or invalid token returns the message `Invalid Token`.'
externalDocs:
description: Pica8 AmpCon API document (source of this transcription)
url: https://pica8-fs.atlassian.net/wiki/spaces/ampcon/pages/753668/AmpCon+API+document