How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cognite Function schedules API

Function schedules allow you to run functions with a specific input at intervals defined by a cron expression. These function calls will be asynchronous and show up in the function call list. Visit http://www.cronmaker.com to generate a cron expression with a UI.

Cognite Function schedules API is one of 90 APIs that Cognite publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Function schedules. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://{cluster}.cognitedata.com/api/v1/projects/{project}.

7 operations 6 paths 20 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.cognitedata.com
Authentication
HTTP Bearer, OAuth 2.0, OAuth 2.0, OAuth 2.0, OpenID Connect
Resource Areas
1

Authentication & Security 5

Cognite Function schedules API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (OpenID Connect or OAuth2 token) (oidc-token). It supports OAuth 2.0 (oauth2-client-credentials) using the clientCredentials flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-auth-code) using the authorizationCode flow, exposing 1 scope. It supports OAuth 2.0 (oauth2-open-industrial-data) using the clientCredentials flow, exposing 1 scope. It supports OpenID Connect (org-oidc-token) discovered at https://auth.cognite.com/.well-known/openid-configuration. By default, every request must be authenticated.

  • oidc-token — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-client-credentials — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-auth-code — Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to acce…
  • oauth2-open-industrial-data — Auth flow for Open Industrial Data. Get your client secret from https://hub.cognite.com/open-industrial-data-211.
  • org-oidc-token — Access token issued by the Cognite authorization server, and valid for the target organization. The token must be an OpenID Connect token, and it can be obtain…

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Function schedules 7

Function schedules allow you to run functions with a specific input at intervals defined by a cron expression. These function calls will be asynchronous and show up in the functio…

GET
/functions/schedules
List schedules
getFunctionSchedules 1 param → 200400
POST
/functions/schedules
Create schedules
postFunctionSchedules body → 201400
POST
/functions/schedules/list
Filter function schedules
listFunctionSchedules body → 200400
GET
/functions/schedules/{scheduleId}
Retrieve a function schedule by its id
getFunctionSchedule 1 param → 200400
POST
/functions/schedules/byids
Retrieve schedules
byIdsFunctionSchedules body → 200400
POST
/functions/schedules/delete
Delete schedules
deleteFunctionSchedules body → 200400
GET
/functions/schedules/{scheduleId}/input_data
Retrieve function input data
getFunctionScheduleInputData 1 param → 200400

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), EpochTimestampRange (2 properties), LimitList (1 property), FunctionScheduleFilter (1 property). Each schema is shown below with its type and property counts.

FunctionScheduleCronExpression
string
Cron expression describes when the function should be called. Use http://www.cronmaker.com to create a cron expression.
FunctionScheduleWhen
string
When the schedule will trigger, in human readable text.
FunctionScheduleDescription
string
Description of function schedule.
FunctionScheduleScope
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
FunctionScheduleIdArray
object
1 property 1 required
data
object
Input data to the function (only present if provided on the schedule). This data is passed deserialized into the function through one of the arguments called d…
CogniteInternalId
integer
A server-generated ID for the object.
FunctionSchedule
7 required
nonce
string
Nonce retrieved from sessions API when creating a session. This will be used to bind the session before executing the function. The corresponding access token…
SessionId
string
Id of the session.
LimitList
object
1 property
FunctionScheduleIds
object
FunctionScheduleId
object
The ID of the function schedule.
1 property 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
FunctionScheduleFilter
object
1 property
Error
object
Cognite API error.
4 properties 2 required
FunctionScheduleName
string
Name of function schedule.
EpochTimestampRange
object
Range between two timestamps (inclusive).
2 properties
IgnoreUnknownIdsField
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-function-schedules-api-openapi.yml Raw ↑

Other APIs Cognite publishes across the network.

Cognite Data Fusion API
Cognite 3D Asset Mapping API
Cognite 3D Files API
Cognite 3D Jobs API
Cognite 3D Model Revisions API
Cognite 3D Models API
Cognite Annotations API
Cognite Assets API
Cognite Connections API
Cognite Containers API
Cognite Data models API
Cognite Data point subscriptions API
Where this information came from

This is an independent, third-party profile of Cognite Function schedules API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.