Oracle Iot API
The iot API from Oracle — 24 operation(s) for iot.
Oracle Iot API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include IoT. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 42 operations across 24 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 20250531.
Requests are made against 2 base URLs: http://127.0.0.1/20250531, https://127.0.0.1/20250531.
42 operations
24 paths
50 schemas
6 DELETE18 GET12 POST6 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 42
Across 24 paths, the API surfaces 42 operations — 6 DELETE, 18 GET, 12 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.
iot 42
GET
/digitalTwinAdapters
Retrieves a list of digital twin adapters within the specified IoT domain.
POST
/digitalTwinAdapters
Creates a new digital twin adapter.
DELETE
/digitalTwinAdapters/{digitalTwinAdapterId}
Deletes the digital twin adapter identified by the specified OCID.
GET
/digitalTwinAdapters/{digitalTwinAdapterId}
Retrieves the digital twin adapter identified by the specified OCID.
PUT
/digitalTwinAdapters/{digitalTwinAdapterId}
Updates the details of digital twin adapter identified by the specified OCID.
GET
/digitalTwinInstances
Retrieves a list of all digital twin instances within the specified IoT domain.
POST
/digitalTwinInstances
Creates a new digital twin instance.
DELETE
/digitalTwinInstances/{digitalTwinInstanceId}
Deletes the digital twin instance identified by the specified OCID.
GET
/digitalTwinInstances/{digitalTwinInstanceId}
Retrieves the digital twin instance identified by the specified OCID.
PUT
/digitalTwinInstances/{digitalTwinInstanceId}
Updates the details of digital twin instance identified by the specified OCID.
POST
/digitalTwinInstances/{digitalTwinInstanceId}/actions/invokeRawCommand
Invokes the raw command on the specified digital twin instance.
GET
/digitalTwinInstances/{digitalTwinInstanceId}/content
Retrieves the content associated with a digital twin instance identified by the specified OCID. The content can be retrieved only when a model is associated with the digital twin instance.
GET
/digitalTwinModels
Retrieve a list of digital twin models within the specified IoT domain.
POST
/digitalTwinModels
Create a new digital twin model.
DELETE
/digitalTwinModels/{digitalTwinModelId}
Deletes the digital twin model identified by the specified OCID.
GET
/digitalTwinModels/{digitalTwinModelId}
Retrieves the digital twin model identified by the specified OCID.
PUT
/digitalTwinModels/{digitalTwinModelId}
Updates the details of the digital twin model identified by the specified OCID.
GET
/digitalTwinModels/{digitalTwinModelId}/spec
Retrieves the spec of digital twin model identified by the specified OCID.
GET
/digitalTwinRelationships
Retrieves a list of digital twin relationships within the specified IoT domain.
POST
/digitalTwinRelationships
Creates a new digital twin relationship.
DELETE
/digitalTwinRelationships/{digitalTwinRelationshipId}
Deletes the digital twin relationship identified by the specified OCID.
GET
/digitalTwinRelationships/{digitalTwinRelationshipId}
Retrieves the digital twin relationship identified by the specified OCID.
PUT
/digitalTwinRelationships/{digitalTwinRelationshipId}
Updates the details of digital twin relationship identified by the specified OCID.
GET
/iotDomainGroups
Retrieves a list of IoT domain groups within the specified compartment.
POST
/iotDomainGroups
Creates a new IoT domain group.
DELETE
/iotDomainGroups/{iotDomainGroupId}
Deletes the IoT domain group identified by the specified OCID.
GET
/iotDomainGroups/{iotDomainGroupId}
Retrieves the IoT domain group identified by the specified OCID.
PUT
/iotDomainGroups/{iotDomainGroupId}
Updates the details of IoT domain group identified by the specified OCID.
POST
/iotDomainGroups/{iotDomainGroupId}/actions/changeCompartment
Changes the compartment of an IoT domain group.
POST
/iotDomainGroups/{iotDomainGroupId}/actions/configureDataAccess
Configures the Data Access of an IoT Domain Group.
GET
/iotDomains
Retrieves a list of IoT domains within the specified compartment.
POST
/iotDomains
Creates a new IoT domain.
DELETE
/iotDomains/{iotDomainId}
Deletes the IoT domain identified by the specified OCID.
GET
/iotDomains/{iotDomainId}
Retrieves the IoT domain identified by the specified OCID.
PUT
/iotDomains/{iotDomainId}
Updates the details of IoT domain identified by the specified OCID.
POST
/iotDomains/{iotDomainId}/actions/changeCompartment
Changes the compartment of an IoT domain.
POST
/iotDomains/{iotDomainId}/actions/changeDataRetentionPeriod
Changes the Data Retention Period of IoT Domain Data.
POST
/iotDomains/{iotDomainId}/actions/configureDataAccess
Configures the Data Access of IoT Domain.
GET
/workRequests
List work requests
GET
/workRequests/{workRequestId}
Get work request status
GET
/workRequests/{workRequestId}/errors
List work request errors
GET
/workRequests/{workRequestId}/logs
List work request logs
Schemas 50
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are DigitalTwinInstanceSummary (17 properties), DigitalTwinInstance (17 properties), IotDomain (15 properties), IotDomainGroup (15 properties). Each schema is shown below with its type and property counts.
DigitalTwinModelSummary
object
Summary of the digital twin model.
11 properties
6 required
DigitalTwinRelationshipSummary
object
Describes digital twin relationship summary
13 properties
8 required
UpdateDigitalTwinModelDetails
object
The information to be updated for the given digital twin model.
4 properties
WorkRequestSummary
object
Summary information about an asynchronous work request.
10 properties
7 required
IotDomainGroupCollection
object
Results of an IoT Domain Group search. Contains both summary and additional metadata information.
1 property
1 required
DigitalTwinInstanceSummary
object
Summary of the digital twin instance
17 properties
6 required
ConfigureIotDomainDataAccessDetails
object
The configuration details for IoT Domain Data Access.
1 property
1 required
DigitalTwinAdapterPayload
object
Reference payload structure template received from IoT device. This payload must specify its content type using the dataFormat property.
1 property
1 required
DigitalTwinAdapter
object
The digital twin adapter maps incoming data from IoT device into the corresponding digital twin instance. It defines the envelope structure, reference payload,…
14 properties
7 required
CreateIotDomainDetails
object
The information about new IoT domain to be created.
6 properties
2 required
IotDomain
object
An IoT domain is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing digital twin resources, such as models…
15 properties
6 required
DataRetentionPeriodsInDays
object
Data Retention periods
4 properties
4 required
WorkRequestSummaryCollection
object
A list of work requests. Can contain both work requests and other information, such as metadata.
1 property
1 required
DigitalTwinAdapterInboundEnvelope
object
Payload containing device-specific metadata and optional value mappings used to interpret or transform that metadata. This structure includes the device endpoi…
3 properties
1 required
CreateDigitalTwinAdapterDetails
object
The information about new digital twin adapter to be created.
9 properties
1 required
IotDomainGroupSummary
object
Summary information about an IoT Domain Group.
11 properties
6 required
DigitalTwinInstanceCollection
object
Results of digital twin instance search. Contains both summary and additional metadata information
1 property
1 required
WorkRequestErrorCollection
object
A list of work request errors. Can contain both errors and other information, such as metadata.
1 property
1 required
WorkRequestError
object
An error encountered while performing an operation that is tracked by a work request.
3 properties
3 required
CreateDigitalTwinInstanceDetails
object
The information about new digital twin instance to be created.
12 properties
1 required
CreateDigitalTwinModelDetails
object
The information about new digital twin model to be created.
6 properties
2 required
WorkRequestLogEntry
object
A log message from performing an operation that is tracked by a work request.
2 properties
2 required
DigitalTwinModel
object
A digital twin model, defined using [Digital Twins Definition Language](https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v3/DTDL.v3.md), specifi…
11 properties
6 required
CreateIotDomainGroupDetails
object
The information about new IoT domain group to be created.
6 properties
1 required
DigitalTwinAdapterCollection
object
Results of a digital twin adapter search. Contains both summary and additional metadata information.
1 property
1 required
UpdateIotDomainGroupDetails
object
The information to be updated for the given IoT domain group.
4 properties
DigitalTwinRelationship
object
A digital twin relationship represents an association between two digital twin instances. It can include properties to describe the nature and context of the a…
14 properties
8 required
ChangeIotDomainGroupCompartmentDetails
object
The configuration details for the move operation.
1 property
1 required
DigitalTwinAdapterInboundRoute
object
Defines how inbound device payloads should be routed and mapped within a digital twin context. Routes are evaluated in the order they are defined, and only the…
4 properties
1 required
ChangeIotDomainCompartmentDetails
object
The configuration details for the move operation.
1 property
1 required
WorkRequest
object
An asynchronous work request helps monitor long-running operations. When you initiate a long-running operation, the service creates a work request. This work r…
10 properties
7 required
DigitalTwinAdapterEnvelopeMapping
object
Maps the metadata fields from the inbound payload using JQ. These mappings allow you to extract specific metadata such as timestamps using JQ expressions.
3 properties
DigitalTwinModelCollection
object
Results of a digital twin model search. Contains both summary and additional metadata information.
1 property
1 required
UpdateDigitalTwinRelationshipDetails
object
The information to be updated for the given digital twin relationship.
5 properties
CreateDigitalTwinRelationshipDetails
object
The information about new digital twin relationship to be created.
9 properties
4 required
WorkRequestResource
object
A resource created or operated on by a work request.
5 properties
3 required
ErrorDetails
object
Error Information.
2 properties
2 required
ConfigureIotDomainGroupDataAccessDetails
object
The configuration details for an IoT Domain Group Data Access through allowlisted vcn ids.
1 property
1 required
UpdateDigitalTwinInstanceDetails
object
The information to be updated for the given digital twin instance.
10 properties
UpdateDigitalTwinAdapterDetails
object
The information to be updated for the given digital twin adapter.
6 properties
UpdateIotDomainDetails
object
The information to be updated for the given IoT domain.
4 properties
DigitalTwinInstance
object
A digital twin instance is a virtual representation of a physical IoT device within the IoT domain. To use any API operations, you must be authorized in an IAM…
17 properties
6 required
WorkRequestLogEntryCollection
object
A list of work request logs. Can contain both logs and other information, such as metadata.
1 property
1 required
DigitalTwinRelationshipCollection
object
Results of digital twin relationships search. Contains both summary and additional metadata information
1 property
1 required
ChangeIotDomainDataRetentionPeriodDetails
object
The configuration details for data retention periods.
2 properties
2 required
InvokeRawCommandDetails
object
Definition of unstructured command invocation payload
5 properties
2 required
DigitalTwinAdapterSummary
object
Summary information about a digital twin adapter.
12 properties
7 required
IotDomainSummary
object
Summary information about a IoT domain.
11 properties
6 required
IotDomainGroup
object
An IoT domain group is an Oracle Cloud Infrastructure resource that provides a managed environment for organizing and managing IoT domains, within a compartmen…
15 properties
6 required
IotDomainCollection
object
Results of an IoT domain search. Contains both summary items and other information, such as metadata.
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#IoT
Where this information came from
This is an independent, third-party profile of Oracle Iot 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.