Services (API)

56KB

Service Manager Schema.yaml

Open

validate a commissioning file

post

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Body

application/json

commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses

200

Validation Successful

No content

400

Validation Error

application/json

406

Invalid Content

application/json

post

/validate/service

HTTPcURLJavaScriptPython

POST /api/validate/service HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}

No content

Create a new service

post

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Body

application/json

idstring · min: 4Required

commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

targetStatestring · enumOptionalPossible values:

Responses

201

Created service

application/json

400

Validation Error

application/json

406

Invalid Content

application/json

409

Conflict with service current state

application/json

500

Internal Server Error

post

/services

HTTPcURLJavaScriptPython

POST /api/services HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "id": "text",
  "commissioningFile": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "marketplace": {
    "filename": "text",
    "directory": "text",
    "version": "text",
    "updatedAt": "2025-12-28T13:18:31.637Z"
  },
  "targetState": "disabled"
}

{
  "id": "text"
}

Read all services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

301

Permanent Redirect

get

/services

HTTPcURLJavaScriptPython

GET /api/services HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

301

Permanent Redirect

No content

Get the service schemas

post

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Body

application/json

commissioningFilestringRequired

The commissioning file of this service as base64 encoded content of a buffer

Responses

201

Service schemas

application/json

400

Validation Error

application/json

406

Invalid Content

application/json

post

/services/parametersSchema

HTTPcURLJavaScriptPython

POST /api/services/parametersSchema HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "commissioningFile": "text"
}

{}

Return the remaining time in milliseconds until the service can be installed

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstring · min: 4Required

Id of the service

Responses

200

OK

application/json

500

Internal Error while fetching service deletion status

application/json

get

/services/{id}/deletion-status

HTTPcURLJavaScriptPython

GET /api/services/{id}/deletion-status HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "serviceID": "text",
  "deletionIsComplete": true,
  "remainingTimeInMs": 1
}

Get a specific service

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

301

Permanent Redirect

get

/services/{id}

HTTPcURLJavaScriptPython

GET /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

301

Permanent Redirect

No content

Update an existing service

put

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

308

Permanent Redirect

put

/services/{id}

HTTPcURLJavaScriptPython

PUT /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

308

Permanent Redirect

No content

Delete an existing service

delete

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstring · min: 4Required

Id of service

Responses

200

OK

application/json

400

Service not found

application/json

delete

/services/{id}

HTTPcURLJavaScriptPython

DELETE /api/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text"
}

Get the service dependencies

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

Service dependencies

application/json

404

Service not found

get

/services/{id}/dependencies

HTTPcURLJavaScriptPython

GET /api/services/{id}/dependencies HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "dependent": [
    "text"
  ],
  "dependsOn": [
    "text"
  ]
}

Get all ingress routes

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Ingress routes

application/json

400

Invalid request

get

/services/ingress-routes

HTTPcURLJavaScriptPython

GET /api/services/ingress-routes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "containerHost": "text",
    "containerPort": 1,
    "containerPrefixRewrite": "text",
    "ingressPort": 1,
    "ingressUrlPrefix": "text",
    "type": "text",
    "headers": [
      "text"
    ]
  }
]

Get all Cybus::Link routes

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Links

application/json

400

Invalid request

get

/services/links

HTTPcURLJavaScriptPython

GET /api/services/links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "ingressRoute": "text",
    "name": "text",
    "href": "text"
  }
]

Get all links by all services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

onlyFromEnabledServicesbooleanOptional

Only list on the response resources from enabled services

Responses

200

Links

application/json

get

/services/all-links

HTTPcURLJavaScriptPython

GET /api/services/all-links HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

Links

[
  {
    "id": "text",
    "name": "text",
    "links": []
  }
]

Perform an operation on a service

put

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Body

application/json

operationstring · enumRequired

Disable and enable

Possible values:

Responses

200

Service

application/json

400

Invalid request

404

Service not found

put

/services/{id}/operation

HTTPcURLJavaScriptPython

PUT /api/services/{id}/operation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "operation": "disable"
}

{
  "serviceId": "myService",
  "name": "My Service",
  "version": "v1.2.3",
  "targetState": "enabled",
  "currentState": "disabled",
  "createdAt": "2025-03-06T22:13:43.065Z",
  "updatedAt": "2025-03-06T22:13:43.065Z"
}

Delete specific resource runner

delete

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstringRequired

Id of resource runner

Responses

200

OK

application/json

400

Invalid request

delete

/resources/runners/{id}

HTTPcURLJavaScriptPython

DELETE /api/resources/runners/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text"
}

Get all of the resource schemas

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Resource schemas in a JSON string

application/json

500

Internal error

get

/resources/schemas

HTTPcURLJavaScriptPython

GET /api/resources/schemas HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": {}
}

Store resources schemas

post

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Body

application/json

schemasobject[] · min: 1Required

List of resources schemas

Responses

201

Resource schemas stored

400

Invalid request

post

/resources/schemas

HTTPcURLJavaScriptPython

POST /api/resources/schemas HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "schemas": [
    {}
  ]
}

No content

Read all services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

searchTextstring · min: 3Optional

The value used to retrieve services by matching service ID or name

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:

orderstring · enumOptional

Ascending or descending order

Possible values:

Responses

200

Array of services

application/json

500

Internal Server Error

get

/v2/services

HTTPcURLJavaScriptPython

GET /api/v2/services HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": [
    {
      "serviceId": "myService",
      "name": "My Service",
      "version": "v1.2.3",
      "targetState": "enabled",
      "currentState": "disabled",
      "createdAt": "2025-03-06T22:13:43.065Z",
      "updatedAt": "2025-03-06T22:13:43.065Z"
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

Get the number of installed Services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

Number of installed Services

application/json

500

Internal Server Error

application/json

get

/v2/services/stats/count

HTTPcURLJavaScriptPython

GET /api/v2/services/stats/count HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": {
    "servicesCount": 1000
  },
  "meta": {}
}

Get paginated list of service IDs for all Services order lexicographically Ascending

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

Responses

200

Get paginated list of service IDs for all Services order lexicographically Ascending

application/json

400

Bad Request

application/json

500

Internal Server Error

application/json

get

/v2/services/ids

HTTPcURLJavaScriptPython

GET /api/v2/services/ids HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": [
    "myService"
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

Get a specific service

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

Service

application/json

404

Service not found

get

/v2/services/{id}

HTTPcURLJavaScriptPython

GET /api/v2/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": {
    "connectwareServiceUuid": "81a6c550-fad5-11ef-a38c-0242ac120006",
    "serviceId": "myService",
    "name": "My Service",
    "description": "My Service has some resources",
    "version": "v1.2.3",
    "provider": "Cybus",
    "homepage": "cybus.io",
    "icon": "TGFyYTwz",
    "targetState": "enabled",
    "currentState": "disabled",
    "totalResources": 105,
    "roleCount": 1,
    "userCount": 2,
    "volumeCount": 3,
    "fileCount": 4,
    "containerCount": 5,
    "ingressRouteCount": 6,
    "linkCount": 7,
    "nodeCount": 8,
    "serverCount": 9,
    "connectionCount": 10,
    "endpointCount": 11,
    "mappingCount": 12,
    "createdAt": "2025-03-06T22:13:43.065Z",
    "updatedAt": "2025-03-06T22:13:43.065Z",
    "parameters": {
      "host": "cybus.io",
      "port": 443
    },
    "marketPlace": {
      "directory": "text",
      "filename": "text",
      "updatedAt": "text",
      "version": "text"
    }
  },
  "meta": {}
}

Update an existing service

put

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Body

application/json

commissioningFilestringOptional

Responses

202

Accepted

application/json

400

Bad Request

application/json

406

Invalid Content

application/json

put

/v2/services/{id}

HTTPcURLJavaScriptPython

PUT /api/v2/services/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 189

{
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "commissioningFile": "text",
  "marketplace": {
    "filename": "text",
    "directory": "text",
    "version": "text",
    "updatedAt": "2025-12-28T13:18:31.637Z"
  }
}

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "meta": {}
}

Get ServiceCommissioningFile for specific service

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

idstringRequired

Id of service

Responses

200

SCF

application/json

400

Bad Request

application/json

404

Service not found

application/json

500

Internal Server Error

application/json

get

/v2/services/{id}/serviceCommissioningFile

HTTPcURLJavaScriptPython

GET /api/v2/services/{id}/serviceCommissioningFile HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": {
    "parameters_schema": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "scf": "text"
  },
  "meta": {}
}

Read resources by for service

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

serviceIdstringRequired

Id of service

Query parameters

runnerNamestring · min: 3Optional

filter by runner name

parentResourceIdstring · min: 3Optional

filter by parentResourceId

searchTextstring · min: 3Optional

The value used to retrieve service resources by matching resource name

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:

orderstring · enumOptional

Ascending or descending order

Possible values:

onlyFromEnabledServicesbooleanOptional

Only list on the response resources from enabled services

Responses

200

Array of services

application/json

400

Bad Request

application/json

500

Internal Server Error

get

/v2/services/{serviceId}/resources

HTTPcURLJavaScriptPython

GET /api/v2/services/{serviceId}/resources HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1"
  },
  "data": [
    {
      "protocol": "text",
      "category": "Node",
      "parentResourceId": "text",
      "resourceConfig": {
        "args": {
          "operation": "serverProvides",
          "topic": "text"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

Read all resources

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

runnerNamestring · min: 3Optional

Resource runner name

parentResourceIdstring · min: 3Optional

Filter by parent of requested resources

searchTextstring · min: 3Optional

The value used to retrieve services resources by matching resource name

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:

orderstring · enumOptional

Ascending or descending order

Possible values:

onlyFromEnabledServicesbooleanOptional

Only list on the response resources from enabled services

Responses

200

Array of resources

application/json

400

Bad Request

application/json

500

Internal Server Error

get

/v2/resources

HTTPcURLJavaScriptPython

GET /api/v2/resources HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1"
  },
  "data": [
    {
      "protocol": "text",
      "category": "Node",
      "parentResourceId": "text",
      "resourceConfig": {
        "args": {
          "operation": "serverProvides",
          "topic": "text"
        }
      }
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

Read a specific resource

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

resourceIdstringRequired

Id of resource

Responses

200

Resource

application/json

404

Resource not found

500

Internal Server Error

get

/v2/resources/{resourceId}

HTTPcURLJavaScriptPython

GET /api/v2/resources/{resourceId} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": {
    "resourceId": "myResource",
    "serviceId": "myService",
    "category": "Node",
    "resourceConfig": {
      "args": {
        "operation": "serverProvides",
        "topic": "text"
      }
    },
    "runnerName": "protocol-mapper",
    "protocol": "text",
    "parentResourceId": "text"
  },
  "meta": {}
}

Update an existing resources

put

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

resourceIdstringRequired

Id of resource

Body

application/json

operationstring · enumRequired

Disable and enable

Possible values:

Responses

200

Success

No content

400

Invalid request

500

Internal Server Error

put

/v2/resources/{resourceId}/operation

HTTPcURLJavaScriptPython

PUT /api/v2/resources/{resourceId}/operation HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "operation": "disable"
}

No content

Get available topics for service ID

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

serviceIdstringRequired

Id of service to list topics for

Query parameters

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:

orderstring · enumOptional

Ascending or descending order

Possible values:

searchTextstringOptional

The value used to retrieve topics by matching resource name or resource ID

onlyFromEnabledServicesbooleanOptional

Only list on the response topics from enabled service

Responses

200

Paginated list of topics

application/json

400

Parameter missing

404

No topics found

500

Internal Server Error

get

/v2/services/{serviceId}/topics

HTTPcURLJavaScriptPython

GET /api/v2/services/{serviceId}/topics HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1"
  },
  "data": [
    {
      "topic": "services/servicea/A/000",
      "serviceId": "servicea",
      "resourceId": "servicea-A_000",
      "category": "Endpoint"
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

Get available topics for resources

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

idsstring[]Optional

The resource IDs to filter by (multiple allowed)

pageinteger · min: 1Optional

Page to return

itemsPerPageinteger · min: 1 · max: 100Optional

Number of items per page

orderBystring · enumOptional

Order response by field

Possible values:

orderstring · enumOptional

Ascending or descending order

Possible values:

searchTextstringOptional

The value used to retrieve topics by matching resource name or resource ID or service ID

onlyFromEnabledServicesbooleanOptional

Only list on the response topics from enabled services

Responses

200

Paginated list of topics

application/json

400

Parameter missing

404

No topics found

500

Internal Server Error

get

/v2/topics/resources

HTTPcURLJavaScriptPython

GET /api/v2/topics/resources HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1"
  },
  "data": [
    {
      "topic": "services/servicea/A/000",
      "serviceId": "servicea",
      "resourceId": "servicea-A_000",
      "category": "Endpoint"
    }
  ],
  "meta": {
    "pagination": {
      "totalPages": 1,
      "totalRows": 1,
      "pageNumber": 1,
      "totalRowsInPage": 1,
      "nextPage": 1,
      "rowsPerPage": 50
    }
  }
}

Get adjacency matrix of services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

List of service relationships

application/json

500

Internal Server Error

get

/v2/service-graph/adjacency-matrix

HTTPcURLJavaScriptPython

GET /api/v2/service-graph/adjacency-matrix HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "dependencies": [
    {
      "fromNode": "text",
      "toNode": "text"
    }
  ]
}

Get all root nodes, i.e. all nodes which have no dependencies

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Responses

200

List of root nodes

application/json

500

Internal Server Error

get

/v2/service-graph/root-nodes

HTTPcURLJavaScriptPython

GET /api/v2/service-graph/root-nodes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "nodes": [
    "text"
  ]
}

Get all dependencies of a list of services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

serviceIdsstringRequired

List of service to get dependencies for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependencies only, 2 to return until dependencies of dependencies, etc.

Responses

200

List of dependencies

application/json

500

Internal Server Error

get

/v2/service-graph/dependencies

HTTPcURLJavaScriptPython

GET /api/v2/service-graph/dependencies?serviceIds=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "nodes": [
    "text"
  ]
}

Get number of dependencies of a service

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

serviceIdstringRequired

Id of service to get dependencies for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependencies only, 2 to return until dependencies of dependencies, etc.

Responses

200

Number of dependencies

No content

500

Internal Server Error

get

/v2/service-graph/dependencies/count

HTTPcURLJavaScriptPython

GET /api/v2/service-graph/dependencies/count?serviceId=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get all dependents of a list services

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

serviceIdsstringRequired

List of services to get dependents for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependents only, 2 to return until dependents of dependents, etc.

Responses

200

List of dependencies

application/json

500

Internal Server Error

get

/v2/service-graph/dependents

HTTPcURLJavaScriptPython

GET /api/v2/service-graph/dependents?serviceIds=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "nodes": [
    "text"
  ]
}

Get number of dependents of a service

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Query parameters

serviceIdstringRequired

Id of service to get dependents for

distanceintegerOptional

Configures how many hops to return, e.g. 1 for direct dependents only, 2 to return until dependents of dependents, etc.

Responses

200

Number of dependents

No content

500

Internal Server Error

get

/v2/service-graph/dependents/count

HTTPcURLJavaScriptPython

GET /api/v2/service-graph/dependents/count?serviceId=text HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Get count of resources by category

get

Authorizations

ApiKeyHeader

AuthorizationstringRequired

Path parameters

categorystring · enumRequired

Resource Category

Possible values:

Responses

200

Resource

application/json

400

Invalid Resource Category provided

application/json

500

Internal Server Error

application/json

get

/v2/resources/count/{category}

HTTPcURLJavaScriptPython

GET /api/v2/resources/count/{category} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "jsonapi": {
    "version": "1.1.1"
  },
  "data": {
    "resourceCount": 1000
  },
  "meta": {}
}