Catchpoint Node API
The Node API from Catchpoint — 13 operation(s) for node.
The Node API from Catchpoint — 13 operation(s) for node.
openapi: 3.0.1
info:
title: Catchpoint REST API v2.0 Account Node API
version: '2.0'
servers:
- url: /api
tags:
- name: Node
paths:
/v2/nodes/{nodeIds}:
get:
tags:
- Node
summary: Returns node details by Node ID.
description: Works only on Enterprise and Customer owned 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.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]'
security:
- bearer: []
order: 2
/v2/nodes:
get:
tags:
- Node
summary: Returns the details of Enterprise Nodes within a Client or a Division.
description: When no parameter is passed, all active node details are returned.
parameters:
- name: name
in: query
description: Node name
schema:
type: string
- name: statusId
in: query
description: Node status. “0” for Active; “1” for Inactive
schema:
type: integer
format: int32
- name: networkType
in: query
description: 'Network Type (refer InternalLink[Test Enumeration Endpoint,operations-tag-Test,operations-Test-get_v2_tests_enumeration]). Accepted values: “3” for Enterprise (pt); “4” for Enterprise'
schema:
type: integer
format: int32
- name: city
in: query
description: City name
schema:
type: string
- name: country
in: query
description: Country name
schema:
type: string
- name: paused
in: query
description: Nodes paused
schema:
type: boolean
- name: ipv6
in: query
description: IPV6 nodes
schema:
type: boolean
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.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]'
security:
- bearer: []
order: 3
/v2/nodes/all:
get:
tags:
- Node
summary: Returns the details of nodes of all network types based on parameters passed.
description: '*[Analytics Endpoint]*'
parameters:
- name: name
in: query
description: Node Name
schema:
type: string
- name: targeted
in: query
description: Nodes used in tests
schema:
type: boolean
- name: active
in: query
description: Nodes in active state
schema:
type: boolean
- name: paused
in: query
description: Nodes paused
schema:
type: boolean
- name: networkType
in: query
description: Network Type (refer InternalLink[Test Enumeration Endpoint,operations-tag-Test,operations-Test-get_v2_tests_enumeration])
schema:
type: integer
format: int32
- name: city
in: query
description: City Name
schema:
type: string
- name: country
in: query
description: Country Name
schema:
type: string
- name: ipv6
in: query
description: IPV6 nodes
schema:
type: boolean
- name: asn
in: query
description: AS name
schema:
type: string
- name: asNumber
in: query
description: AS number
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.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]]'
security:
- bearer: []
order: 1
/v2/nodes/state/{nodeIds}:
get:
tags:
- Node
summary: Returns the Node state, paused or not, based on the Node IDs passed.
description: Works only on Enterprise and Customer owned 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.NodeResponse`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.NodeResponse`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.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel]]]'
security:
- bearer: []
order: 5
/v2/nodes/state:
patch:
tags:
- Node
summary: Allows to pause or resume an existing node.
description: "Works only on Enterprise and Customer owned Nodes.\r\n \r\nTo get payload for updating a Node State refer InternalLink[Node State Endpoint,operations-tag-Node,operations-Node-get_v2_nodes_state__nodeIds_]. State ID values – “0” for Resume; “1” for Pause. There can be multiple nodes in the payload for which the state 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.NodeResponse`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.NodeResponse`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.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]]'
security:
- bearer: []
order: 6
/v2/nodes/status/{nodeIds}:
get:
tags:
- Node
summary: Returns the Node status, active or inactive, based on the Node IDs passed.
description: Works on Enterprise Nodes and Customer owned 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.NodeResponse`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.NodeResponse`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.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.StatusModel]]]'
security:
- bearer: []
order: 7
/v2/nodes/status:
patch:
tags:
- Node
summary: Allows to set the status of an existing node to Active or Inactive.
description: "Works only on Enterprise and Customer owned Nodes.\r\n \r\nTo get payload for updating a Node Status refer InternalLink[Node Status Endpoint,operations-tag-Node,operations-Node-get_v2_nodes_status__nodeIds_] Endpoint. Status ID values – “0” for Active; “1” for Inactive. There can be multiple nodes 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.NodeResponse`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.NodeResponse`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.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]]'
security:
- bearer: []
order: 8
/v2/nodes/{nodeId}:
patch:
tags:
- Node
summary: Update properties of an existing node.
description: "Works only on Enterprise and Customer owned Nodes.\r\n \r\n**Request:**\r\n \r\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:\r\n* **value** – The value property provides the new value.\r\n \r\n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\r\n \r\n* **op** – The op property indicates the type of operation; we support the following three operations.\r\n \r\n * **add** - Add a property or array element. For existing property: set value.\r\n \r\n * **Remove** - Remove a property or array element.\r\n \r\n * **replace** - Same as remove followed by add at same location.\r\n \r\n* **from** - [Not Used]\r\n \r\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: nodeId
in: path
description: Node 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.NodeResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int16]]]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int16]]]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.IIdResponse`1[System.Int16]]]'
security:
- bearer: []
order: 4
/v2/nodes/os:
get:
tags:
- Node
summary: Returns a list of all the operating system names that match the parameter passed.
description: If no parameter is passed, list of all the operating system names running on the nodes are returned.
parameters:
- name: osName
in: query
description: Operating System Name. A “contains” operation is performed on the parameter.
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.OsResponse]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.OsResponse]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.OsResponse]'
security:
- bearer: []
order: 10
/v2/nodes/isp:
get:
tags:
- Node
summary: Returns a list of all the ISP names that match the parameter passed.
description: If no parameter is passed, list of all the ISP names of the nodes are returned.
parameters:
- name: ispName
in: query
description: ISP Name. A “contains” operation is performed on the parameter.
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.IspResponse]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.IspResponse]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.IspResponse]'
security:
- bearer: []
order: 11
/v2/nodes/package:
get:
tags:
- Node
summary: Returns the available enterprise packages for the Client or Division.
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.EnterprisePackageResponse]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnterprisePackageResponse]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.EnterprisePackageResponse]'
security:
- bearer: []
order: 9
/v2/nodes/geographycity:
get:
tags:
- Node
summary: Returns all the available cities that can be used while creating a Node.
parameters:
- name: cityName
in: query
description: City Name. A “contains” operation is performed on the parameter.
schema:
type: string
- 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.GeographyCityResponse]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.GeographyCityResponse]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.GeographyCityResponse]'
security:
- bearer: []
order: 12
/v2/nodes/chromeversions:
get:
tags:
- Node
summary: Retrieves the Chrome versions information for the Enterprise node, this will include all versions installed on the node, even if not targeted.
parameters:
- name: nodeId
in: query
description: The id of an enterprise node.
schema:
type: integer
format: int32
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.ChromeVersionsResponse]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ChromeVersionsResponse]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ChromeVersionsResponse]'
security:
- bearer: []
order: 13
post:
tags:
- Node
summary: Update the chrome versions for the specified Enterprise node based on the payload sent.
requestBody:
description: Specifies the node id, stable version, preview version, and additional specific versions to auto-install on a node.
content:
application/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Requests.v2_0.ChromeVersionsRequestModel'
application/json-patch+json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Requests.v2_0.ChromeVersionsRequestModel'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Requests.v2_0.ChromeVersionsRequestModel'
application/*+json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Requests.v2_0.ChromeVersionsRequestModel'
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.ChromeVersionsResponse]'
text/plain:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ChromeVersionsResponse]'
text/json:
schema:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.ChromeVersionsResponse]'
security:
- bearer: []
order: 14
components:
schemas:
? Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]]
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]'
messages:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
nullable: true
errors:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
nullable: true
completed:
type: boolean
readOnly: true
traceId:
type: string
nullable: true
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.CityModel:
type: object
properties:
city:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]'
state:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]'
country:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.IspResponse]:
type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.IspResponse'
messages:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
nullable: true
errors:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
nullable: true
completed:
type: boolean
readOnly: true
traceId:
type: string
nullable: true
usageLimits:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Api.ApiUsageStatistics'
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel:
type: object
properties:
instances:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.Node.InstanceResponseModel'
nullable: true
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
nullable: true
longitude:
type: string
nullable: true
runRate:
type: number
format: double
nullable: true
instanceCount:
type: integer
format: int32
activeInstanceCount:
type: integer
format: int32
capacity:
type: integer
format: int32
id:
type: integer
format: int32
name:
type: string
nullable: true
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
nullable: true
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
format: int32
nullable: true
additionalProperties: false
Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[System.Int32]]:
type: object
properties:
nodes:
type: array
items:
type: integer
format: int32
nullable: true
hasMore:
type: boolean
nullable: true
next:
type: string
nullable: true
previous:
type: string
nullable: true
additionalProperties: false
? Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]]
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.PublicNodeModel]]'
messages:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Models.InfoMessage'
nullable: true
errors:
type: array
items:
$ref: '#/components/schemas/Catchpoint.Symphony.ViewModels.MessageModel'
nullable: true
completed:
type: boolean
readOnly: true
traceId:
type: string
nullable: true
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.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]]
: type: object
properties:
data:
$ref: '#/components/schemas/Catchpoint.Symphony.REST.Common.Response.v2_0.NodeResponse`1[System.Collections.Generic.List`1[Catchpoint.Symphony.REST.Common.Response.v2_0.Node.NodeResponseModel]]'
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/catchpoint/refs/heads/main/openapi/catchpoint-node-api-openapi.yml