Patch By ID
DescriptionThis operation should be used to update Provider Details (credentials) of a provider instance
Request
URLURL
Path Parameters
Path Parameters
Provider instance ID
Provider label
Query Parameters
Query Parameters
If true, errors classified as warnings will be ignored
Organization ID: non-super users can only access their own organization
Request Body
{
"name": "My Provider Instance"
}
User defined operations to be denied on this instance
Possible values are: EDGE_DEPLOYMENT , TEMPLATE_CREATION , UAG_DEPLOYMENT
User defined description
User defined name
Resource tags that are added to Provider Instance
Authentication
Response
Response BodyResponse Body
200 OK
Successfully updated provider instance
{
"credentialId": "0123456789",
"edgeDeploymentId": "0123456789",
"id": "0123456789",
"infraTwinId": "0123456789",
"infraTwinSyncStatus": "READY",
"location": "US",
"name": "My Instance Name",
"orgId": "0123456789",
"primaryProvider": false,
"providerLabel": "AZURE"
}
Record creation timestamp
ID of the credential storing the sensitive data of provider
User defined operations to be denied on this instance
Possible values are: EDGE_DEPLOYMENT , TEMPLATE_CREATION , UAG_DEPLOYMENT
User defined description for this instance
EdgeGateway Deployment which we can use to manage and monitor infrastructure
Unique record ID
Id of the Infrastructure Twin which can be use to talk to the corresponding infra module.
Status of this provider instance
Possible values are: NONE , SYNCED , SYNC_NEEDED
Links to all infrastructure available from this provider
location
User defined name for this instance
Org ID that owns this record
True if this provider has an edge deployment deployed in it.
Provider label (provider of which this is an instance)
Resource tags that are added to Provider Instance
Record update timestamp
Record version (internal)
204 No Content
No Content
Errors
Bad Request
Unauthorized
Forbidden
Not Found
Provider disabled
Unexpected internal server error
Code Samples
cURL Command
Vendor Extensions
x-codegen-request-body-name: patchProviderInstance
