The resource API from NEXTDC — 7 operation(s) for resource.
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/nextdc:nextdc-resource-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: Nextdc Resource API
version: '1'
description: 'Operations tagged resource 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: Resource
paths:
/v1/resource/PROVIDERS:
get:
operationId: bizApiResourceAvailableProvidersBiz
tags:
- Resource
parameters:
- name: provider
description: Comma separated list of B-end providers (no spaces) (optional)
in: query
required: false
schema:
type: string
- name: scope
description: Provider scope
in: query
required: false
schema:
type: string
enum:
- node
- port
- name: class
description: Provider class
in: query
required: false
schema:
type: string
summary: Get all available resource providers 🔐
description: Providers are the resource provider components that comprise a service. For providers with a service class a regex can be used. For example, "oob" will return all oob providers, and ".*:axon" will return all services supplied by the axon provider.
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/resource/TYPES:
get:
operationId: bizApiResourceRetrieveResourceAvailableTypesBiz
tags:
- Resource
parameters:
- name: scope
description: Type scope (optional)
in: query
required: false
schema:
type: string
enum:
- port
- address
- name: class
description: Resource type class (optional)
in: query
required: false
schema:
type: string
summary: Get all available resource types 🔐
description: Available resource types to create and order. Can be filtered by resource type scope and class. Use the information returned to filter resource discovery.
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/resource/{company_id}:
post:
operationId: bizApiResourceAllocateResourceBiz
tags:
- Resource
parameters:
- name: company_id
description: Company ID
in: path
required: true
schema:
type: string
summary: Allocate the next available resource 🔐
description: Use the GET resources/{company_id}/DISCOVER call to obtain the available resource types across the various locations. Then use the information obtained to allocate a single or diverse resource to an already allocated guid of the same type.
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
security:
- api_key: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/bizApiResourceAllocateResourceBizModel'
description: "**location_id** (required) \n**resource_type_class** (required) \n**resource_options** (required) \n**contract_term** (required) \ndiverse_resource_guid \ncandidate_resource_guid \ndiscount_code \npurchase_order \ndocument_ids \n"
required: true
servers:
- url: https://sandbox-api.axonvx.com/api/biz2
/v1/resource/{resource_guid}:
delete:
operationId: bizApiResourceUnallocateResourceBiz
tags:
- Resource
parameters:
- name: resource_guid
description: Resource GUID
in: path
required: true
schema:
type: string
- name: document_ids
description: Document ID string. Providing this string will record the current session data as a signature on the document
in: query
required: false
schema:
type: array
items:
type: string
summary: Delete an allocated resource 🔐
description: Unallocate a resource. There may be no services defined on the resource.
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/resource/customer/{resource_guid}:
put:
operationId: bizApiResourceUpdateCustomerResourceBiz
tags:
- Resource
parameters:
- name: resource_guid
description: Resource GUID
in: path
required: true
schema:
type: string
summary: Update a customer resource details 🔐
description: Function to update customer resource details. This includes fabric-interconnect and public/hidden resources
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
security:
- api_key: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/bizApiResourceUpdateCustomerResourceBizModel'
description: "**description** (required) \nresource_advertisement \npurchase_order \ndocument_ids \n"
required: true
servers:
- url: https://sandbox-api.axonvx.com/api/biz2
/v1/resource/LAG/{resource_guid}:
put:
operationId: bizApiLagResourceUpdateLagResourceBiz
tags:
- Resource
parameters:
- name: resource_guid
description: Resource GUID
in: path
required: true
schema:
type: string
summary: Update a resource to a LAG 🔐
description: Function to turn an existing resource into a LAG resource.
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
security:
- api_key: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/bizApiLagResourceUpdateLagResourceBizModel'
description: "**description** (required) \nlag_mode \n"
required: true
servers:
- url: https://sandbox-api.axonvx.com/api/biz2
/v1/resource/LAG/{resource_guid}/{lag_resource_guid}:
put:
operationId: bizApiLagResourceUpdateAssociateLagResourceBiz
tags:
- Resource
parameters:
- name: resource_guid
description: Resource GUID
in: path
required: true
schema:
type: string
- name: lag_resource_guid
description: LAG Resource GUID
in: path
required: true
schema:
type: string
summary: Associate a resource to a LAG 🔐
description: Function to associate an existing resource into a LAG resource.
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
type: string
security:
- api_key: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/bizApiLagResourceUpdateAssociateLagResourceBizModel'
description: "**description** (required) \nlag_mode \n"
required: true
servers:
- url: https://sandbox-api.axonvx.com/api/biz2
components:
schemas:
bizApiResourceAllocateResourceBizModel:
properties:
location_id:
type: string
description: Location ID
resource_type_class:
type: string
description: Resource type class
resource_options:
$ref: '#/components/schemas/mixed'
description: Resource Options
contract_term:
type: integer
format: int64
description: Contract term in months. Refer to GET /resources/{company_id}/DISCOVER for available options
diverse_resource_guid:
type: string
description: Ensure resource is diverse to this resource GUID (optional)
candidate_resource_guid:
type: string
description: Candidate resource GUID (optional)
discount_code:
type: string
description: Promotional discount code (optional)
maximum: 50
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:
- location_id
- resource_type_class
- resource_options
- contract_term
bizApiResourceUpdateCustomerResourceBizModel:
properties:
description:
type: string
description: Resource description
maximum: 200
resource_advertisement:
type: string
description: Resource advertisement (optional)
maximum: 255
purchase_order:
type: string
description: PO Number for billing 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:
- description
bizApiLagResourceUpdateLagResourceBizModel:
properties:
description:
type: string
description: LAG resource description
maximum: 200
lag_mode:
type: string
description: LAG mode (optional lacp,static)
enum:
- lacp
- static
required:
- description
bizApiLagResourceUpdateAssociateLagResourceBizModel:
properties:
description:
type: string
description: LAG resource description
maximum: 200
lag_mode:
type: string
description: LAG mode (optional lacp,static)
enum:
- lacp
- static
required:
- description
mixed:
properties:
description:
type: string
description: $description Resource description. Used as a reference for billing records (must be unique)
required:
- description
securitySchemes:
api_key:
type: apiKey
name: api_key
in: query
x-refined-from:
- axon-swagger.json
- nextdc-axon-openapi.yml