Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
DriverDefinition

Update a Resource Driver.

put/orgs/{orgId}/resources/drivers/{driverId}

Path parameters

orgIdstring required

The Organization ID.

driverIdstring required

The Resource Driver ID.

Request body

account_typesstring[] required

List of resources accounts types supported by the driver

inputs_schemaobject required

A JSON Schema specifying the driver-specific input parameters.

targetstring required

The prefix where the driver resides or, if the driver is a virtual driver, the reference to an existing driver using the driver:// schema of the format driver://{orgId}/{driverId}. Only members of the organization the driver belongs to can see 'target'.

{"stackTrail":"components:schemas:UpdateDriverRequestRequest:properties:template","oasType":"schema","type":"unknown","description":"If the driver is a virtual driver, template defines a Go template that converts the driver inputs supplied in the resource definition into the driver inputs for the target driver."}
typestring required

The type of resource produced by this driver

is_publicboolean

Example request

{
  "account_types": [
    "gcp",
    "aws"
  ],
  "inputs_schema": {},
  "is_public": false,
  "target": "https://drivers.example.com/route53/",
  "template": "{{ mustToRawJson .driver }}",
  "type": "dns"
}

Response

The updated Resources Driver details.

account_typesstring[] required

List of resources accounts types supported by the driver

idstring required

The ID for this driver. Is used as driver_type.

inputs_schemaobject required

A JSON Schema specifying the driver-specific input parameters.

org_idstring required

The Organization this driver exists under. Useful as public drivers are accessible to other orgs.

targetstring

The prefix where the driver resides or, if the driver is a virtual driver, the reference to an existing driver using the driver:// schema of the format driver://{orgId}/{driverId}. Only members of the organization the driver belongs to can see target.

{"stackTrail":"components:schemas:DriverDefinitionResponse:properties:template","oasType":"schema","type":"unknown","description":"If the driver is a virtual driver, template defines a Go template that converts the driver inputs supplied in the resource definition into the driver inputs for the target driver."}
typestring required

The type of resource produced by this driver

Example response

{
  "account_types": [
    "gcp",
    "aws"
  ],
  "id": "route53",
  "inputs_schema": {},
  "is_public": false,
  "org_id": "test-org",
  "target": "https://drivers.example.com/route53/",
  "template": "",
  "type": "dns"
}