{ "opencollection": "1.0.0", "info": { "name": "Internet of Things Iot API", "version": "20250531" }, "items": [ { "info": { "name": "iot", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a list of digital twin adapters within the specified IoT domain.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinAdapters", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.\n" }, { "name": "digitalTwinModelSpecUri", "value": "", "type": "query", "description": "Filter resources that match the specified URI (DTMI) of the digital twin model.\n" }, { "name": "digitalTwinModelId", "value": "", "type": "query", "description": "Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "Filter resources whose display name matches the specified value.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter resources whose lifecycleState matches the specified value.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "Page representing the requested page of items." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Retrieves a list of digital twin adapters within the specified IoT domain.\n" }, { "info": { "name": "Creates a new digital twin adapter.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/digitalTwinAdapters", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new digital twin adapter." }, { "info": { "name": "Retrieves the digital twin adapter identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinAdapters/:digitalTwinAdapterId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinAdapterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.\n" } ] }, "docs": "Retrieves the digital twin adapter identified by the specified OCID." }, { "info": { "name": "Updates the details of digital twin adapter identified by the specified OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250531/digitalTwinAdapters/:digitalTwinAdapterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinAdapterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of digital twin adapter identified by the specified OCID." }, { "info": { "name": "Deletes the digital twin adapter identified by the specified OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250531/digitalTwinAdapters/:digitalTwinAdapterId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinAdapterId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin adapter.\n" } ] }, "docs": "Deletes the digital twin adapter identified by the specified OCID." }, { "info": { "name": "Retrieves a list of all digital twin instances within the specified IoT domain.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "Filter resources whose display name matches the specified value.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "Page representing the requested page of items." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter resources whose lifecycleState matches the specified value.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" }, { "name": "digitalTwinModelId", "value": "", "type": "query", "description": "Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the digital twin model.\n" }, { "name": "digitalTwinModelSpecUri", "value": "", "type": "query", "description": "Filter resources that match the specified URI (DTMI) of the digital twin model.\n" }, { "name": "connectivityType", "value": "", "type": "query", "description": "Filter resources whose connectivityType matches the specified value.\n" }, { "name": "iotDomainId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.\n" } ] }, "docs": "Retrieves a list of digital twin instances within the specified IoT domain.\n" }, { "info": { "name": "Creates a new digital twin instance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/digitalTwinInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new digital twin instance.\n" }, { "info": { "name": "Retrieves the digital twin instance identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinInstances/:digitalTwinInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.\n" } ] }, "docs": "Retrieves the digital twin instance identified by the specified OCID." }, { "info": { "name": "Updates the details of digital twin instance identified by the specified OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250531/digitalTwinInstances/:digitalTwinInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of digital twin instance identified by the specified OCID." }, { "info": { "name": "Deletes the digital twin instance identified by the specified OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250531/digitalTwinInstances/:digitalTwinInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.\n" } ] }, "docs": "Deletes the digital twin instance identified by the specified OCID." }, { "info": { "name": "Invokes the raw command on the specified digital twin instance.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/digitalTwinInstances/:digitalTwinInstanceId/actions/invokeRawCommand", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Invokes the raw command on the specified digital twin instance.\n" }, { "info": { "name": "Retrieves the content associated with a digital twin instance identified by the specified OCID.\nThe content can be retrieved only when a model is associated with the digital twin instance.\n", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinInstances/:digitalTwinInstanceId/content", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinInstanceId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin instance.\n" }, { "name": "shouldIncludeMetadata", "value": "", "type": "query", "description": "If set to true , digital twin instance metadata is included in the response." } ] }, "docs": "Retrieves the content associated with a digital twin instance identified by the specified OCID.\nThe content can be retrieved only when a model is associated with the digital twin instance.\n" }, { "info": { "name": "Retrieve a list of digital twin models within the specified IoT domain.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinModels", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.\n" }, { "name": "iotDomainId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "Filter resources whose display name matches the specified value.\n" }, { "name": "specUriStartsWith", "value": "", "type": "query", "description": "Filters resources by spec URI prefix. For example, to search all versions of the `dtmi:example:device;1` model, pass the prefix without the version: `dtmi:example:device`.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "Page representing the requested page of items." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter resources whose lifecycleState matches the specified value.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Retrieves a list of digital twin models within the specified IoT domain.\n" }, { "info": { "name": "Create a new digital twin model.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/digitalTwinModels", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new digital twin model.\n" }, { "info": { "name": "Retrieves the digital twin model identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinModels/:digitalTwinModelId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinModelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin model." } ] }, "docs": "Retrieves the digital twin model identified by the specified OCID." }, { "info": { "name": "Updates the details of the digital twin model identified by the specified OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250531/digitalTwinModels/:digitalTwinModelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinModelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin model." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of the digital twin model identified by the specified OCID." }, { "info": { "name": "Deletes the digital twin model identified by the specified OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250531/digitalTwinModels/:digitalTwinModelId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinModelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin model." } ] }, "docs": "Deletes the digital twin model identified by the specified OCID." }, { "info": { "name": "Retrieves the spec of digital twin model identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinModels/:digitalTwinModelId/spec", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinModelId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin model." } ] }, "docs": "Retrieves the spec of digital twin model identified by the specified OCID." }, { "info": { "name": "Retrieves a list of digital twin relationships within the specified IoT domain.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinRelationships", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "Filter resources whose display name matches the specified value.\n" }, { "name": "contentPath", "value": "", "type": "query", "description": "Filters resources that match the content path of the digital twin relationship.\n" }, { "name": "sourceDigitalTwinInstanceId", "value": "", "type": "query", "description": "Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of source digital twin instance.\n" }, { "name": "targetDigitalTwinInstanceId", "value": "", "type": "query", "description": "Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of target digital twin instance.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter resources whose lifecycleState matches the specified value.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "Page representing the requested page of items." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" }, { "name": "iotDomainId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain in which to list digital twin resources.\n" }, { "name": "id", "value": "", "type": "query", "description": "Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.\n" } ] }, "docs": "Retrieves a list of digital twin relationships within the specified IoT domain.\n" }, { "info": { "name": "Creates a new digital twin relationship.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/digitalTwinRelationships", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new digital twin relationship.\n" }, { "info": { "name": "Retrieves the digital twin relationship identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/digitalTwinRelationships/:digitalTwinRelationshipId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinRelationshipId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship." } ] }, "docs": "Retrieves the digital twin relationship identified by the specified OCID." }, { "info": { "name": "Updates the details of digital twin relationship identified by the specified OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250531/digitalTwinRelationships/:digitalTwinRelationshipId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinRelationshipId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of digital twin relationship identified by the specified OCID." }, { "info": { "name": "Deletes the digital twin relationship identified by the specified OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250531/digitalTwinRelationships/:digitalTwinRelationshipId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "digitalTwinRelationshipId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of digital twin relationship." } ] }, "docs": "Deletes the digital twin relationship identified by the specified OCID." }, { "info": { "name": "Retrieves a list of IoT domain groups within the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/iotDomainGroups", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.\n" }, { "name": "displayName", "value": "", "type": "query", "description": "Filter resources whose display name matches the specified value.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter resources whose lifecycleState matches the specified value." }, { "name": "type", "value": "", "type": "query", "description": "Filter resources by type. Valid values are LIGHTWEIGHT or STANDARD." }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination: The value of the opc-next-page response header from the previous \"List\" call.\nFor important details on how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Retrieves a list of IoT domain groups within the specified compartment.\n" }, { "info": { "name": "Creates a new IoT domain group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomainGroups", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new IoT domain group.\n" }, { "info": { "name": "Retrieves the IoT domain group identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/iotDomainGroups/:iotDomainGroupId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group." } ] }, "docs": "Retrieves the IoT domain group identified by the specified OCID." }, { "info": { "name": "Updates the details of IoT domain group identified by the specified OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250531/iotDomainGroups/:iotDomainGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of IoT domain group identified by the specified OCID." }, { "info": { "name": "Deletes the IoT domain group identified by the specified OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250531/iotDomainGroups/:iotDomainGroupId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group." } ] }, "docs": "Deletes the IoT domain group identified by the specified OCID." }, { "info": { "name": "Changes the compartment of an IoT domain group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomainGroups/:iotDomainGroupId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "iotDomainGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an IoT domain group to a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Configures the Data Access of an IoT Domain Group.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomainGroups/:iotDomainGroupId/actions/configureDataAccess", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "iotDomainGroupId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an IoT Domain Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IoT domain Group Data Access.\n" }, { "info": { "name": "Retrieves a list of IoT domains within the specified compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/iotDomains", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "Filter resources by [OCID](/iaas/Content/General/Concepts/identifiers.htm). Must be a valid OCID of the resource type.\n" }, { "name": "iotDomainGroupId", "value": "", "type": "query", "description": "Filter resources that match the specified [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain group." }, { "name": "displayName", "value": "", "type": "query", "description": "Filter resources whose display name matches the specified value.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Filter resources whose lifecycleState matches the specified value.\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "page", "value": "", "type": "query", "description": "For list pagination: The value of the opc-next-page response header from the previous \"List\" call.\nFor important details on how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided.\nDefault order for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Retrieves a list of IoT domains within the specified compartment.\n" }, { "info": { "name": "Creates a new IoT domain.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomains", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new IoT domain.\n" }, { "info": { "name": "Retrieves the IoT domain identified by the specified OCID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/iotDomains/:iotDomainId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain." } ] }, "docs": "Retrieves the IoT domain identified by the specified OCID." }, { "info": { "name": "Updates the details of IoT domain identified by the specified OCID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20250531/iotDomains/:iotDomainId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the details of IoT domain identified by the specified OCID." }, { "info": { "name": "Deletes the IoT domain identified by the specified OCID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20250531/iotDomains/:iotDomainId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain." } ] }, "docs": "Deletes the IoT domain identified by the specified OCID." }, { "info": { "name": "Changes the compartment of an IoT domain.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomains/:iotDomainId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an IoT domain to a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Changes the Data Retention Period of IoT Domain Data.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomains/:iotDomainId/actions/changeDataRetentionPeriod", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates Data Retention Period of the IoT Domain.\n" }, { "info": { "name": "Configures the Data Access of IoT Domain.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20250531/iotDomains/:iotDomainId/actions/configureDataAccess", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "iotDomainId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IoT domain." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IoT domain Data Access.\n" }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "id", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination: The value of the opc-next-page response header from the previous \"List\" call.\nFor important details on how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be specified. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists work requests in the specified compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Retrieves the status of the work request with the given ID." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination: The value of the opc-next-page response header from the previous \"List\" call.\nFor important details on how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be specified. The default order for `timeCreated` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." } ] }, "docs": "Lists errors associated with the specified work request.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20250531/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination: The value of the opc-next-page response header from the previous \"List\" call.\nFor important details on how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be specified. The default order for `timeCreated` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Specifies sort order to use, either ASC (ascending) or DESC (descending)." } ] }, "docs": "Lists the logs associated with the specified work request.\n" } ] } ], "bundled": true }