How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Portainer custom_templates API

Manage Custom Templates

Portainer custom_templates API is one of 32 APIs that Portainer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 9 operations across 7 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 2.39.1.

Requests are made against a single base URL, /api.

9 operations 7 paths 16 schemas 1 DELETE3 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.39.1
Base URL
https://api-docs.portainer.io
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Portainer custom_templates API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). An API key is passed in the header as Authorization (jwt).

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 3 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

custom_templates 9

Manage Custom Templates

GET
/custom_templates
List available custom templates
CustomTemplateList 2 params → 200500
DELETE
/custom_templates/{id}
Remove a template
CustomTemplateDelete 1 param → 204400403404500
GET
/custom_templates/{id}
Inspect a custom template
CustomTemplateInspect 1 param → 200400404500
PUT
/custom_templates/{id}
Update a template
CustomTemplateUpdate 1 param body → 200400403404500
GET
/custom_templates/{id}/file
Get Template stack file content.
CustomTemplateFile 1 param → 200400404500
PUT
/custom_templates/{id}/git_fetch
Fetch the latest config file content based on custom template's git repository configuration
CustomTemplateGitFetch 1 param → 200400404500
POST
/custom_templates/create/file
Create a custom template
CustomTemplateCreateFile body → 200400500
POST
/custom_templates/create/repository
Create a custom template
CustomTemplateCreateRepository body → 200400500
POST
/custom_templates/create/string
Create a custom template
CustomTemplateCreateString body → 200400500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are customtemplates.customTemplateUpdatePayload (19 properties), customtemplates.customTemplateFromGitRepositoryPayload (16 properties), portainer.CustomTemplate (15 properties), portainer.ResourceControl (11 properties). Each schema is shown below with its type and property counts.

customtemplates.customTemplateUpdatePayload
object
19 properties 5 required
portainer.UserResourceAccess
object
2 properties
customtemplates.fileResponse
object
1 property
customtemplates.customTemplateFromFileContentPayload
object
9 properties 4 required
portainer.TeamResourceAccess
object
2 properties
portainer.StackType
integer
portainer.ResourceControlType
integer
gittypes.GitCredentialAuthType
integer
customtemplates.customTemplateFromGitRepositoryPayload
object
16 properties 4 required
portainer.CustomTemplateVariableDefinition
object
4 properties
gittypes.GitAuthentication
object
4 properties
portainer.CustomTemplatePlatform
integer
portainer.CustomTemplate
object
15 properties
gittypes.RepoConfig
object
6 properties
portainer.ResourceAccessLevel
integer
portainer.ResourceControl
object
11 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portainer-custom-templates-api-openapi.yml Raw ↑

Other APIs Portainer publishes across the network.

Portainer auth API
Portainer backup API
Portainer docker API
Portainer edge API
Portainer edge_groups API
Portainer edge_jobs API
Portainer edge_stacks API
Portainer endpoint_groups API
Portainer endpoints API
Portainer gitops API
Portainer helm API
Portainer intel API
Where this information came from

This is an independent, third-party profile of Portainer custom_templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.