3DS OUTSCALE Templates API
The Templates API from 3DS OUTSCALE — 5 operation(s) for templates.
The Templates API from 3DS OUTSCALE — 5 operation(s) for templates.
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/outscale:outscale-templates-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: Outscale Templates API
version: '1.0'
description: 'Operations tagged Templates across 2 of this provider''s published API definitions: osc-sdk-go_api.yaml, outscale-oks-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /{api_prefix}
variables:
api_prefix:
default: api/v2
description: API prefix
security:
- BasicAuth: []
OTPCodeAuth: []
- AccessKeyAuth: []
SecretKeyAuth: []
OTPCodeAuth: []
- AccessTokenAuth: []
RefreshTokenAuth: []
tags:
- name: Templates
paths:
/templates/project:
get:
tags:
- Templates
summary: Get Project Template
description: Retrieves the default project template, including predefined network configurations, region, and metadata. Returns a JSON response containing the request context and template details, such as CIDR block, project name, region, description, and tags.
operationId: GetProjectTemplate
parameters: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_ProjectInput_'
'422':
description: ValidationError
content:
application/json:
example:
Errors:
- Type: ValidationError
Details:
- loc:
- string
- 0
msg: string
type: string
Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: /{api_prefix}
variables:
api_prefix:
default: api/v2
description: API prefix
/templates/cluster:
get:
tags:
- Templates
summary: Get Cluster Template
description: Retrieves the default cluster template, including predefined control plane configurations, networking settings, and maintenance schedules. Returns a JSON response containing the request context and template details, such as control plane type, CIDR ranges for pods and services, admission flags, multi-AZ support, Kubernetes version, subregions, and scheduled automatic maintenance settings.
operationId: GetClusterTemplate
parameters:
- name: X-Real-IP
in: header
required: false
schema:
type:
- string
- 'null'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_ClusterInputTemplate_'
'422':
description: ValidationError
content:
application/json:
example:
Errors:
- Type: ValidationError
Details:
- loc:
- string
- 0
msg: string
type: string
Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: /{api_prefix}
variables:
api_prefix:
default: api/v2
description: API prefix
/templates/nodepool:
get:
tags:
- Templates
summary: Get Nodepool Template
description: Retrieves the default node pool template, including predefined configurations for node scaling, storage, and upgrade strategies. Returns a JSON response containing the request context and template details, such as node count, node type, availability zones, volume specifications, upgrade strategy, and auto-healing settings.
operationId: GetNodepoolTemplate
parameters: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_Nodepool_'
'422':
description: ValidationError
content:
application/json:
example:
Errors:
- Type: ValidationError
Details:
- loc:
- string
- 0
msg: string
type: string
Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: /{api_prefix}
variables:
api_prefix:
default: api/v2
description: API prefix
/templates/netpeeringrequest:
get:
tags:
- Templates
summary: Get Netpeering Request Template
description: NetPeering Request manifest
operationId: GetNetPeeringRequestTemplate
parameters: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_NetPeeringRequest_'
'422':
description: ValidationError
content:
application/json:
example:
Errors:
- Type: ValidationError
Details:
- loc:
- string
- 0
msg: string
type: string
Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: /{api_prefix}
variables:
api_prefix:
default: api/v2
description: API prefix
/templates/netpeeringacceptance:
get:
tags:
- Templates
summary: Get Netpeering Acceptance Template
description: NetPeering Acceptance manifest
operationId: GetNetPeeringAcceptanceTemplate
parameters: []
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateResponse_NetPeeringAcceptance_'
'422':
description: ValidationError
content:
application/json:
example:
Errors:
- Type: ValidationError
Details:
- loc:
- string
- 0
msg: string
type: string
Code: '422'
ResponseContext:
RequestId: 45a64090-2e5b-428f-bfea-83a5f783f9e6
schema:
$ref: '#/components/schemas/ErrorResponse'
servers:
- url: /{api_prefix}
variables:
api_prefix:
default: api/v2
description: API prefix
components:
schemas:
templates__template_schema__ResponseContext:
properties:
RequestId:
type: string
title: Request ID
description: Unique identifier for the API request
type: object
required:
- RequestId
title: ResponseContext
ClusterInputTemplate:
properties:
project_id:
type: string
title: Project ID
description: Unique identifier of the project this cluster belongs to
description:
type:
- string
- 'null'
version:
type: string
title: Kubernetes Version
description: Version of Kubernetes to be deployed
admin_lbu:
type: boolean
title: Admin LBU
description: Flag to enable admin load balancer for cluster management
default: false
admission_flags:
allOf:
- $ref: '#/components/schemas/AdmissionFlagsInput'
title: Admission Flags
description: Configuration for Kubernetes admission controllers
default: {}
cidr_pods:
type: string
title: Pods CIDR
description: CIDR block for Kubernetes pods network
example: 10.91.0.0/16
cidr_service:
type: string
title: Service CIDR
description: CIDR block for Kubernetes services network
example: 10.92.0.0/16
cluster_dns:
type: string
title: Cluster DNS
description: IP address for cluster DNS service
example: 10.92.0.10
tags:
additionalProperties:
type: string
type: object
title: Tags
description: Key-value pairs for cluster metadata
example:
key: value
auto_maintenances:
allOf:
- $ref: '#/components/schemas/AutoMaintenances'
maintenance_window:
allOf:
- $ref: '#/components/schemas/Maintenance'
control_planes:
type: string
title: Control Planes
description: Size of control plane deployment for the cluster
default: cp.3.masters.small
admin_whitelist:
items:
type: string
type: array
title: Admin Whitelist
description: List of CIDR blocks or IP addresses allowed to access the Kubernetes API
quirks:
items:
type: string
type:
- array
- 'null'
disable_api_termination:
type: boolean
title: Disable API Termination
description: Flag to prevent accidental cluster deletion
default: false
example: false
type: object
required:
- project_id
- version
- admin_whitelist
title: ClusterInputTemplate
TemplateResponse_NetPeeringRequest_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
Template:
allOf:
- $ref: '#/components/schemas/NetPeeringRequest'
title: Template
description: Template resource returned by the API
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[NetPeeringRequest]
SpecNetPeeringAcceptance:
properties:
netPeeringId:
type: string
title: NetID
description: Net Peering ID
type: object
required:
- netPeeringId
title: SpecNetPeeringAcceptance
SpecNetPeeringRequest:
properties:
accepterNetId:
type: string
title: Accepter NetID
description: NetID (VPC ID) of the target
accepterOwnerId:
type: string
title: Accepter Owner ID
description: Owner ID (Account ID) of the target
type: object
required:
- accepterNetId
- accepterOwnerId
title: SpecNetPeeringRequest
Maintenance:
properties:
duration_hours:
type: integer
maximum: 23.0
minimum: 0.0
title: Duration Hours
description: Duration of the maintenance window in hours
start_hour:
type: integer
maximum: 23.0
minimum: 0.0
title: Start Hour
description: Hour of the day when maintenance window starts (0-23)
week_day:
type: string
enum:
- Mon
- Tue
- Wed
- Thu
- Fri
- Sat
- Sun
- string
title: Week Day
description: Day of the week for the maintenance window
tz:
type: string
title: Timezone
description: Timezone for the maintenance window
default: UTC
type: object
required:
- duration_hours
- start_hour
- week_day
title: Maintenance
ErrorResponse:
properties:
Errors:
items:
$ref: '#/components/schemas/ErrorItem'
type: array
title: Errors
ResponseContext:
$ref: '#/components/schemas/ResponseContext-Input'
type: object
required:
- Errors
- ResponseContext
title: ErrorResponse
AutoMaintenances:
properties:
minor_upgrade_maintenance:
allOf:
- $ref: '#/components/schemas/MaintenanceWindow'
title: Minor Upgrade Maintenance
description: Maintenance window configuration for minor Kubernetes upgrades
patch_upgrade_maintenance:
allOf:
- $ref: '#/components/schemas/MaintenanceWindow'
title: Patch Upgrade Maintenance
description: Maintenance window configuration for patch Kubernetes upgrades
type: object
required:
- minor_upgrade_maintenance
- patch_upgrade_maintenance
title: AutoMaintenances
ErrorItem:
properties:
Type:
type: string
title: Type
Details:
anyOf:
- type: string
- items:
$ref: '#/components/schemas/ValidationDetail'
type: array
Code:
type: string
title: Code
type: object
required:
- Type
- Details
- Code
title: ErrorItem
AdmissionFlagsInput:
properties:
disable_admission_plugins:
items:
type: string
type: array
title: Disable Admission Plugins
description: List of Kubernetes admission plugins to disable
enable_admission_plugins:
items:
type: string
type: array
title: Enable Admission Plugins
description: List of Kubernetes admission plugins to enable
type: object
title: AdmissionFlagsInput
MaintenanceWindow:
properties:
enabled:
type: boolean
title: Enabled
description: Flag to enable or disable the maintenance window
default: true
duration_hours:
type: integer
maximum: 23.0
minimum: 0.0
title: Duration Hours
description: Duration of the maintenance window in hours
default: 0
start_hour:
type: integer
maximum: 23.0
minimum: 0.0
title: Start Hour
description: Hour of the day when maintenance window starts (0-23)
default: 12
week_day:
type: string
enum:
- Mon
- Tue
- Wed
- Thu
- Fri
- Sat
- Sun
- string
title: Week Day
description: Day of the week for the maintenance window
default: Tue
tz:
type: string
title: Timezone
description: Timezone for the maintenance window
default: UTC
type: object
title: MaintenanceWindow
Spec:
properties:
desiredNodes:
type: string
title: Desired Nodes
description: Number of nodes desired in the nodepool
nodeType:
type: string
title: Node Type
description: Instance type for the nodes
zones:
items:
type: string
type: array
title: Zones
description: List of availability zones where nodes should be deployed
volumes:
items:
$ref: '#/components/schemas/Volume'
type: array
title: Volumes
description: List of volume configurations for the nodes
upgradeStrategy:
allOf:
- $ref: '#/components/schemas/UpgradeStrategy'
title: Upgrade Strategy
description: Configuration for managing nodepool upgrades
autoHealing:
type: boolean
title: Auto Healing
description: Flag to enable automatic healing of failed nodes
type: object
required:
- desiredNodes
- nodeType
- zones
- volumes
- upgradeStrategy
- autoHealing
title: Spec
UpgradeStrategy:
properties:
maxUnavailable:
type: integer
title: Max Unavailable
description: Maximum number of nodes that can be unavailable during an upgrade
maxSurge:
type: integer
title: Max Surge
description: Maximum number of extra nodes that can be created during an upgrade
autoUpgradeEnabled:
type: boolean
title: Auto Upgrade Enabled
description: Flag to enable automatic upgrades for the nodepool
autoUpgradeMaintenance:
allOf:
- $ref: '#/components/schemas/AutoUpgradeMaintenance'
title: Auto Upgrade Maintenance
description: Configuration for the automated upgrade maintenance window
type: object
required:
- maxUnavailable
- maxSurge
- autoUpgradeEnabled
- autoUpgradeMaintenance
title: UpgradeStrategy
AutoUpgradeMaintenance:
properties:
durationHours:
type: integer
title: Duration Hours
description: Duration of the maintenance window in hours
startHour:
type: integer
maximum: 23.0
minimum: 0.0
title: Start Hour
description: Hour of the day when maintenance window starts (0-23)
weekDay:
type: string
enum:
- Mon
- Tue
- Wed
- Thu
- Fri
- Sat
- Sun
title: Week Day
description: Day of the week for the maintenance window (e.g., Mon, Tue)
type: object
required:
- durationHours
- startHour
- weekDay
title: AutoUpgradeMaintenance
TemplateResponse_ProjectInput_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
Template:
allOf:
- $ref: '#/components/schemas/ProjectInput'
title: Template
description: Template resource returned by the API
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[ProjectInput]
NetPeeringRequest:
properties:
apiVersion:
type: string
title: API Version
description: Version of the NetPeeringRequest API being used
kind:
type: string
title: Kind
description: Resource type, always 'NetPeeringRequest' for netpeering request resources
metadata:
allOf:
- $ref: '#/components/schemas/netpeerings__netpeering_schema__Metadata'
description: Metadata information for the netpeering request
spec:
allOf:
- $ref: '#/components/schemas/SpecNetPeeringRequest'
title: Spec
description: Specification of the netpeering request configuration
type: object
required:
- apiVersion
- kind
- metadata
- spec
title: NetPeeringRequest
ProjectInput:
properties:
name:
type: string
maxLength: 40
minLength: 1
pattern: ^[a-z][a-z0-9-]*[a-z0-9]$
title: Project Name
description: Unique name for the project, must start with a letter and contain only lowercase letters, numbers, or hyphens
example: awesome-project
description:
type: string
title: Description
description: Optional description of the project
default: ''
cidr:
type: string
title: VPC CIDR
description: CIDR block associated with the project's VPC
region:
type: string
title: Region
description: Region where the project is deployed
tags:
additionalProperties:
type: string
type:
- object
- 'null'
quirks:
items:
type: string
type:
- array
- 'null'
disable_api_termination:
type: boolean
title: Disable API Termination
description: Flag to prevent accidental project deletion
default: false
example: false
type: object
required:
- name
- cidr
- region
title: ProjectInput
ResponseContext-Input:
properties:
RequestId:
type: string
title: Requestid
type: object
required:
- RequestId
title: ResponseContext
NetPeeringAcceptance:
properties:
apiVersion:
type: string
title: API Version
description: Version of the NetPeeringAcceptance API being used
kind:
type: string
title: Kind
description: Resource type, always 'NetPeeringAcceptance' for netpeering acceptance resources
metadata:
allOf:
- $ref: '#/components/schemas/netpeerings__netpeering_schema__Metadata'
description: Metadata information for the netpeering acceptance
spec:
allOf:
- $ref: '#/components/schemas/SpecNetPeeringAcceptance'
title: Spec
description: Specification of the netpeering acceptance configuration
type: object
required:
- apiVersion
- kind
- metadata
- spec
title: NetPeeringAcceptance
Nodepool:
properties:
apiVersion:
type: string
title: API Version
description: Version of the Nodepool API being used
kind:
type: string
title: Kind
description: Resource type, always 'Nodepool' for nodepool resources
metadata:
allOf:
- $ref: '#/components/schemas/nodepools__nodepool_schema__Metadata'
description: Metadata information for the nodepool
spec:
allOf:
- $ref: '#/components/schemas/Spec'
description: Specification of the nodepool configuration
type: object
required:
- apiVersion
- kind
- metadata
- spec
title: Nodepool
TemplateResponse_Nodepool_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
Template:
allOf:
- $ref: '#/components/schemas/Nodepool'
title: Template
description: Template resource returned by the API
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[Nodepool]
Volume:
properties:
device:
type: string
title: Device
description: Device name for the volume
type:
type: string
title: Type
description: Type of the volume (gp2, io1, standard)
size:
type: integer
title: Size
description: Size of the volume
dir:
type: string
title: Directory
description: Mount point directory path for the volume
type: object
required:
- device
- type
- size
- dir
title: Volume
TemplateResponse_NetPeeringAcceptance_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
Template:
allOf:
- $ref: '#/components/schemas/NetPeeringAcceptance'
title: Template
description: Template resource returned by the API
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[NetPeeringAcceptance]
TemplateResponse_ClusterInputTemplate_:
properties:
ResponseContext:
$ref: '#/components/schemas/templates__template_schema__ResponseContext'
Template:
allOf:
- $ref: '#/components/schemas/ClusterInputTemplate'
title: Template
description: Template resource returned by the API
type: object
required:
- ResponseContext
- Template
title: TemplateResponse[ClusterInputTemplate]
netpeerings__netpeering_schema__Metadata:
properties:
name:
type: string
title: Name
description: Unique name identifier for the netpeering
type: object
required:
- name
title: Metadata
nodepools__nodepool_schema__Metadata:
properties:
name:
type: string
title: Name
description: Unique name identifier for the nodepool
type: object
required:
- name
title: Metadata
ValidationDetail:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Loc
msg:
type: string
title: Msg
type:
type: string
title: Type
type: object
required:
- loc
- msg
- type
title: ValidationDetail
securitySchemes:
BasicAuth:
type: http
scheme: basic
description: Username and Password for API authentication
AccessKeyAuth:
type: apiKey
in: header
name: AccessKey
description: AccessKey for API authentication
SecretKeyAuth:
type: apiKey
in: header
name: SecretKey
description: SecretKey for API authentication
AccessTokenAuth:
type: apiKey
in: header
name: AccessToken
description: Access Token for API authentication
RefreshTokenAuth:
type: apiKey
in: header
name: RefreshToken
description: Refresh Token for API authentication
OTPCodeAuth:
type: apiKey
in: header
name: X-OTP-Code
description: OTP token for API authentication
x-refined-from:
- osc-sdk-go_api.yaml
- outscale-oks-openapi.yml