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 Jobs API

A hosted extractor **job** represents the running extractor. Jobs produce logs and metrics that give the state of the job. For details on available states and metrics see documentation [here](https://docs.cognite.com/cdf/integration/guides/extraction/hosted_extractors).

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

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

This API exposes 7 operations across 6 paths, and defines 42 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 42 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 Jobs 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.

Jobs 7

A hosted extractor job represents the running extractor. Jobs produce logs and metrics that give the state of the job. For details on available states and metrics see documentatio…

GET
/hostedextractors/jobs
List Jobs
list_jobs 5 params → 200400422
POST
/hostedextractors/jobs
Create Jobs
create_jobs body → 200400422
POST
/hostedextractors/jobs/byIds
Retrieve Jobs
retrieve_jobs body → 200400422
POST
/hostedextractors/jobs/delete
Delete Jobs
delete_jobs body → 200400422
GET
/hostedextractors/jobs/logs
Get Job Logs
get_job_logs 5 params → 200400422
GET
/hostedextractors/jobs/metrics
Get Job Metrics
get_job_metrics 5 params → 200400422
POST
/hostedextractors/jobs/update
Update Jobs
update_jobs body → 200400422

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are MinimalJob (12 properties), JobMetrics (10 properties), RestJobConfig (8 properties), CreateJob (8 properties). Each schema is shown below with its type and property counts.

EncodingType
string
The type of encoding to convert from. - utf8, UTF-8, default. - utf16, UTF-16 big endian. - utf16le, UTF-16 little endian. - latin1, Latin 1, Specifically Wind…
MQTTJobConfig
object
1 property 1 required
Items_JobLogEntry_
object
1 property 1 required
ValueFormat
object
Assume the source data is on the form some string or 123.456, and convert these into CDF datapoints, using prefix config to determine the timeseries external I…
5 properties 1 required
KafkaJobConfig
object
2 properties 1 required
HeaderValueConfig
object
3 properties 3 required
MinimalJob
object
12 properties 9 required
CreateJob
object
8 properties 4 required
EpochTimestamp
integer
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
ItemsWithCursor_MinimalJob_
object
2 properties 1 required
Items_CreateJob_
object
1 property 1 required
UpdateItem_JobTargetStatus_
object
Set a new job target status.
1 property 1 required
CustomFormat
object
5 properties 3 required
PrefixConfig
object
Generate a prefix for resources created using this format. If both prefix and fromTopic are set, the generated ID will be on the form [prefix][topic][id]
2 properties
JobUpdateItem
object
2 properties 2 required
UpdateFormat
object
Set a new format.
1 property 1 required
CogniteFormat
object
Convert from the special cognite format to CDF datapoints.
5 properties 1 required
JobLogEntry
object
4 properties 3 required
ExternalIdWrapper
object
1 property 1 required
Items_JobUpdateItem_
object
1 property 1 required
RockwellFormat
object
Transform data on the Rockwell FactoryTalk format into CDF timeseries
5 properties 1 required
RestInterval
string
CompressionType
string
The compression applied to incoming messages. The messages are decompressed before being passed to transformations. This is usually not relevant for REST, wher…
QueryParameterConfig
object
3 properties 3 required
NextUrlConfig
object
2 properties 2 required
Items_MinimalJob_
object
1 property 1 required
UpdateItem_SourceId_
object
Set a new source this job should write to.
1 property 1 required
JobUpdate
object
5 properties
ItemsWithIgnoreUnknownIds_ExternalId_
object
2 properties 1 required
CogniteExternalId
string
The external ID provided by the client. Must be unique for the resource type.
BodyPaginationConfig
object
2 properties 2 required
Items_JobMetrics_
object
1 property 1 required
JobTargetStatus
string
The target status of a job. Set this to start or stop the job.
ValidationErrorContent
object
Cognite API error.
2 properties 2 required
WriteCustomFormat
object
Format the source data using a custom mapping.
4 properties 2 required
JobConfig
Source specific job configuration. The type depends on the type of source, and is required for some sources.
RestJobConfig
object
8 properties 2 required
Error
object
Cognite API error.
4 properties 2 required
UpdateItem_JobConfig_
object
Set a new source specific job config.
1 property
DataModels
object
Data models configuration to specify the space for all instances.
1 property 1 required
UpdateItem_DestinationId_
object
Set a new destination this job should write to.
1 property 1 required
JobMetrics
object
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cognite-jobs-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 Jobs 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.