Catchpoint Instances API
The Instances API from Catchpoint — 6 operation(s) for instances.
The Instances API from Catchpoint — 6 operation(s) for instances.
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/catchpoint-instances-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: Catchpoint REST API v2.0 Account Instances API
version: '2.0'
servers:
- url: /api
tags:
- name: Instances
paths:
/v2/instances/{nodeIds}:
get:
tags:
- Instances
summary: Return details of the Node and all associated Instances.
description: Works only on Enterprise Nodes.
parameters:
- name: nodeIds
in: path
description: Comma-separated list of Node IDs
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse'
security:
- bearer: []
order: 1
/v2/instances:
get:
tags:
- Instances
summary: Returns the Instance details based on the parameters passed.
description: "Works only on Enterprise Nodes.\n \nWhen no parameter is passed, all Instances within the Client or Division are returned."
parameters:
- name: name
in: query
description: Instance Name
schema:
type: string
- name: nodeId
in: query
description: Node ID
schema:
type: integer
format: int32
- name: statusId
in: query
description: Instance Status. “0” for Active; “1” for Inactive
schema:
type: integer
format: int32
- name: core
in: query
description: Comma-separated list of core values
schema:
type: string
- name: os
in: query
description: Comma-separated list of OS names
schema:
type: string
- name: memory
in: query
description: Memory value
schema:
type: integer
format: int32
- name: pageNumber
in: query
description: Page number to return records from when the number of records exceeds pageSize
schema:
type: integer
format: int32
default: 1
- name: pageSize
in: query
description: Number of results that is returned per page. Maximum value is 100.
schema:
type: integer
format: int32
default: 100
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
security:
- bearer: []
order: 2
post:
tags:
- Instances
summary: Create a new instance within a new node or add a new instance to an existing node.
description: "Works only on Enterprise Nodes.\n \nTo get payload for creating a new instance and to get the created instance details refer InternalLink[Instance Details By Node ID Endpoint,operations-tag-Instance,operations-Instance-get_v2_instances__nodeIds_]. Pass “0” for instance ID to create a new instance."
parameters:
- name: objectDetails
in: query
description: Set to true to return the created object in the response body, otherwise the response body will only return created object ID.
schema:
type: boolean
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
application/json-patch+json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
application/*+json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
security:
- bearer: []
order: 3
/v2/instances/{instanceId}:
patch:
tags:
- Instances
summary: Update properties of an existing instance based on the request body.
description: "Works only on Enterprise Nodes.\n \n**Request:**\n \nOnly the property to be updated can be passed in the request body instead of the whole object. The update request body requires a total of three keys to be filled with appropriate value as listed below:\n* **value** – The value property provides the new value.\n \n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\n \n* **op** – The op property indicates the type of operation; we support the following three operations.\n \n * **add** - Add a property or array element. For existing property: set value.\n \n * **Remove** - Remove a property or array element.\n \n * **replace** - Same as remove followed by add at same location.\n \n* **from** - [Not Used]\n \n * **Explanation** - The \"from\" parameter represents the starting or current value of the resource that the operation intends to modify. The from parameter is included in the example value schema but is not utilized in this endpoint's functionality. It is reserved for potential future use or could be used in specific scenarios not covered by the current implementation."
parameters:
- name: instanceId
in: path
description: Instance ID
required: true
schema:
type: integer
format: int32
- name: objectDetails
in: query
description: Set to true to return the updated object in the response body, otherwise the response body will only return the updated object ID.
schema:
type: boolean
requestBody:
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation'
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/Microsoft.AspNetCore.JsonPatch.Operations.Operation'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
security:
- bearer: []
order: 4
/v2/instances/status/{instanceIds}:
get:
tags:
- Instances
summary: Returns the Instance status, active or inactive, based on the Instance IDs passed.
description: Works on Enterprise Nodes and Customer owned Nodes.
parameters:
- name: instanceIds
in: path
description: Comma-separated list of Instance IDs
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
security:
- bearer: []
order: 5
/v2/instances/status:
patch:
tags:
- Instances
summary: Allows to set the status of an existing instance to Active or Inactive.
description: "Works only on Enterprise and Customer owned Nodes.\n \nTo get payload for updating an Instance Status refer InternalLink[Instance Status Endpoint,operations-tag-Instance,operations-Instance-get_v2_instances_status__instanceIds_]. Status ID values – “0” for Active; “1” for Inactive. There can be multiple instances in the payload for which the status update is intended."
requestBody:
description: ''
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
application/json-patch+json:
schema:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
text/json:
schema:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
application/*+json:
schema:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_System.Int32'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_System.Int32'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_System.Int32'
security:
- bearer: []
order: 6
/v2/instances/hardware/{nodeId}:
get:
tags:
- Instances
summary: Returns the instance hardware usage based on the Node ID.
description: "Works only on Enterprise Nodes.\n \nThe maximum time range allowed is 7 days over the period of last 365 days."
parameters:
- name: nodeId
in: path
description: Node ID
required: true
schema:
type: integer
format: int32
- name: startDate
in: query
description: Start date in UTC (YYYY-MM-DDThh:mm)
schema:
type: string
- name: endDate
in: query
description: End date in UTC (YYYY-MM-DDThh:mm)
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse'
security:
- bearer: []
order: 7
components:
schemas:
Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int32:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse:
type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
errors:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
completed:
type: boolean
readOnly: true
traceId:
type:
- string
- 'null'
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Microsoft.AspNetCore.JsonPatch.Operations.Operation:
type: object
properties:
value: {}
path:
type:
- string
- 'null'
op:
type:
- string
- 'null'
from:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel:
type: object
properties:
activationKey:
type:
- string
- 'null'
node:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel'
id:
type: integer
format: int32
hostName:
type:
- string
- 'null'
status:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
operatingSystem:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
macAddress:
type:
- string
- 'null'
internalIpAddress:
type:
- string
- 'null'
core:
type: integer
format: int32
memory:
type: integer
format: int32
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel
: type: object
properties:
instance:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
hasMore:
type:
- boolean
- 'null'
next:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse:
type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
errors:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
completed:
type: boolean
readOnly: true
traceId:
type:
- string
- 'null'
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_System.Int32
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_System.Int32'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
errors:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
completed:
type: boolean
readOnly: true
traceId:
type:
- string
- 'null'
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_System.Int32:
type: object
properties:
instance:
type:
- array
- 'null'
items:
type: integer
format: int32
hasMore:
type:
- boolean
- 'null'
next:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel:
type: object
properties:
instances:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
isPaused:
type: boolean
country:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int16'
state:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int32'
continent:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
latitude:
type:
- string
- 'null'
longitude:
type:
- string
- 'null'
runRate:
type:
- number
- 'null'
format: double
instanceCount:
type: integer
format: int32
activeInstanceCount:
type: integer
format: int32
capacity:
type: integer
format: int32
id:
type: integer
format: int32
name:
type:
- string
- 'null'
status:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
networkType:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
osType:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
size:
type: integer
format: int32
isIPv6:
type: boolean
nodeToNodeAddress:
type:
- string
- 'null'
internetServiceProvider:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int32'
city:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int32'
package:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int32'
utilizedInstances:
type:
- integer
- 'null'
format: int32
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeInstanceResponse:
type: object
properties:
nodes:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel'
hasMore:
type:
- boolean
- 'null'
next:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.ViewModels.MessageModel:
type: object
properties:
id:
type:
- string
- 'null'
message:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Api.ConsumerStatistics:
type: object
properties:
consumerId:
type: integer
format: int32
requestCount:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit'
maxPerDay:
type:
- integer
- 'null'
format: int32
additionalProperties: false
Catchpoint.Symphony.REST.Api.Limit:
type: object
properties:
minute:
type: integer
format: int32
hour:
type: integer
format: int32
day:
type: integer
format: int32
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
errors:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
completed:
type: boolean
readOnly: true
traceId:
type:
- string
- 'null'
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Int16:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath:
type: object
properties:
ops:
type:
- string
- 'null'
path:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics:
type: object
properties:
divisionId:
type: integer
format: int32
consumerStatistics:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ConsumerStatistics'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceUsageResponse:
type: object
properties:
node:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel'
instanceUsages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.Node.InstanceUsageResponseModel'
hasMore:
type:
- boolean
- 'null'
next:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel:
type: object
properties:
id:
type: integer
format: int32
name:
type:
- string
- 'null'
status:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte'
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.APIResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
messages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
errors:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
completed:
type: boolean
readOnly: true
traceId:
type:
- string
- 'null'
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Models.InfoMessage:
type: object
properties:
information:
type:
- string
- 'null'
ignoredPath:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath'
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32
: type: object
properties:
instance:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32'
hasMore:
type:
- boolean
- 'null'
next:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse_1_System.Int32:
type: object
properties:
id:
type: integer
format: int32
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.v2_0.InstanceResponse_1_System.Collections.Generic.List_1_Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel
: type: object
properties:
instance:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel'
hasMore:
type:
- boolean
- 'null'
next:
type:
- string
- 'null'
previous:
type:
- string
- 'null'
additionalProperties: false
Catchpoint.Symphony.REST.Api.ApiUsageStatistics:
type: object
properties:
clientId:
type: integer
format: int64
lastRequestTimestamp:
type: string
format: date-time
limits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit'
runs:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.Limit'
exceededMessage:
type:
- string
- 'null'
readOnly: true
divisionUsageStatistics:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.DivisionUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.ViewModels.Node.InstanceUsageResponseModel:
type: object
properties:
instanceId:
type: integer
format: int32
instanceName:
type:
- string
- 'null'
cpuUsages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.DataPointModel'
memoryUsages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.DataPointModel'
diskUsages:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.DataPointModel'
additionalProperties: false
Catchpoint.Symphony.ViewModels.EnumLookupModel_1_System.Byte:
type: object
properties:
id:
type: integer
format: int32
name:
# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/catchpoint/refs/heads/main/openapi/catchpoint-instances-api-openapi.yml