API - Corsair

Every render.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Blueprints

disconnect

blueprints.disconnect Disconnect a Render Blueprint; its resources are kept Risk: destructive

await corsair.render.api.blueprints.disconnect({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

list

blueprints.list List Render Blueprints Risk: read

await corsair.render.api.blueprints.list({});

Input

Name	Type	Required	Description
`ownerId`	`string[]`	No	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
}[]

listSyncs

blueprints.listSyncs List syncs for a Render blueprint Risk: read

await corsair.render.api.blueprints.listSyncs({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

blueprints.retrieve Retrieve a Render Blueprint Risk: read

await corsair.render.api.blueprints.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

blueprints.update Update a Render Blueprint Risk: write

await corsair.render.api.blueprints.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`body`	`object`	Yes	—

body full type

{
}

Output: object[]

Output full type

{
} | {
}[]

validate

blueprints.validate Validate a Render Blueprint configuration Risk: read

await corsair.render.api.blueprints.validate({ ownerId: 'tea-cjnxpkdhshc73d12t9i0', file: 'services:\n  - type: web\n    name: api\n    runtime: node\n' });

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`file`	`string`	Yes	Contents of the render.yaml to validate

Output: object[]

Output full type

{
} | {
}[]

Build Sources

builds.list

buildSources.builds.list List builds for a Render build source Risk: read

await corsair.render.api.buildSources.builds.list({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

builds.retrieve

buildSources.builds.retrieve Retrieve a Render build source build Risk: read

await corsair.render.api.buildSources.builds.retrieve({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`buildId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

builds.trigger

buildSources.builds.trigger Trigger a Render build source build Risk: write

await corsair.render.api.buildSources.builds.trigger({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

create

buildSources.create Create a Render build source Risk: write

await corsair.render.api.buildSources.create({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`name`	`string`	Yes	—
`projectId`	`string`	No	—
`git`	`object`	No	—
`image`	`object`	No	—

git full type

{
}

image full type

{
}

Output: object[]

Output full type

{
} | {
}[]

delete

buildSources.delete Delete a Render build source Risk: destructive

await corsair.render.api.buildSources.delete({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envGroups.link

buildSources.envGroups.link Link an environment group to a Render build source Risk: write

await corsair.render.api.buildSources.envGroups.link({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envGroupId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.unlink

buildSources.envGroups.unlink Unlink an environment group from a Render build source Risk: destructive

await corsair.render.api.buildSources.envGroups.unlink({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envGroupId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envVars.delete

buildSources.envVars.delete Delete an environment variable from a Render build source Risk: destructive

await corsair.render.api.buildSources.envVars.delete({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envVars.list

buildSources.envVars.list List environment variables for a Render build source Risk: read

await corsair.render.api.buildSources.envVars.list({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

envVars.retrieve

buildSources.envVars.retrieve Retrieve an environment variable for a Render build source Risk: read

await corsair.render.api.buildSources.envVars.retrieve({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envVars.update

buildSources.envVars.update Replace all environment variables on a Render build source with the given list; variables not listed are deleted Risk: destructive

await corsair.render.api.buildSources.envVars.update({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`body`	`object[]`	Yes	—

body full type

(
  {
    key: string,
    value: string
  } | {
    key: string,
    generateValue: boolean
  }
)[]

Output: object[]

Output full type

{
}[]

envVars.upsert

buildSources.envVars.upsert Add or update an environment variable for a Render build source Risk: write

await corsair.render.api.buildSources.envVars.upsert({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
}

Output: object[]

Output full type

{
} | {
}[]

list

buildSources.list List Render build sources Risk: read

await corsair.render.api.buildSources.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

buildSources.retrieve Retrieve a Render build source Risk: read

await corsair.render.api.buildSources.retrieve({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

secretFiles.delete

buildSources.secretFiles.delete Delete a secret file from a Render build source Risk: destructive

await corsair.render.api.buildSources.secretFiles.delete({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

secretFiles.list

buildSources.secretFiles.list List secret files for a Render build source Risk: read

await corsair.render.api.buildSources.secretFiles.list({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

secretFiles.retrieve

buildSources.secretFiles.retrieve Retrieve a secret file for a Render build source Risk: read

await corsair.render.api.buildSources.secretFiles.retrieve({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

secretFiles.update

buildSources.secretFiles.update Replace all secret files on a Render build source with the given list; files not listed are deleted Risk: destructive

await corsair.render.api.buildSources.secretFiles.update({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`body`	`object[]`	Yes	—

body full type

{
  name: string,
  content: string
}[]

Output: object[]

Output full type

{
}[]

secretFiles.upsert

buildSources.secretFiles.upsert Add or update a secret file for a Render build source Risk: write

await corsair.render.api.buildSources.secretFiles.upsert({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
}

Output: object[]

Output full type

{
} | {
}[]

update

buildSources.update Update a Render build source Risk: write

await corsair.render.api.buildSources.update({});

Input

Name	Type	Required	Description
`buildSourceId`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
}

Output: object[]

Output full type

{
} | {
}[]

Dedicated Ips

create

dedicatedIps.create Create a Render dedicated IP set Risk: write

await corsair.render.api.dedicatedIps.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`region`	`frankfurt \| oregon \| ohio \| singapore \| virginia`	Yes	—
`description`	`string`	No	—
`environmentIds`	`string[]`	No	—

Output: object[]

Output full type

{
} | {
}[]

delete

dedicatedIps.delete Delete a Render dedicated IP set Risk: destructive

await corsair.render.api.dedicatedIps.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

list

dedicatedIps.list List Render dedicated IP sets Risk: read

await corsair.render.api.dedicatedIps.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	Yes	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

dedicatedIps.retrieve Retrieve a Render dedicated IP set Risk: read

await corsair.render.api.dedicatedIps.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

dedicatedIps.update Update a Render dedicated IP set Risk: write

await corsair.render.api.dedicatedIps.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`body`	`object`	Yes	—

body full type

{
}

Output: object[]

Output full type

{
} | {
}[]

Disks

create

disks.create Create a disk for a Render service Risk: write

await corsair.render.api.disks.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`sizeGB`	`number`	Yes	—
`mountPath`	`string`	Yes	—
`serviceId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

delete

disks.delete Delete a Render disk Risk: destructive

await corsair.render.api.disks.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

list

disks.list List Render disks Risk: read

await corsair.render.api.disks.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

listSnapshots

disks.listSnapshots List snapshots for a Render disk Risk: read

await corsair.render.api.disks.listSnapshots({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

restoreSnapshot

disks.restoreSnapshot Restore a snapshot to a Render disk Risk: write

await corsair.render.api.disks.restoreSnapshot({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`snapshotKey`	`string`	Yes	—
`instanceId`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

retrieve

disks.retrieve Retrieve a Render disk Risk: read

await corsair.render.api.disks.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

disks.update Update a Render disk Risk: write

await corsair.render.api.disks.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`sizeGB`	`number`	No	—
`mountPath`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

Events

retrieve

events.retrieve Retrieve a Render event Risk: read

await corsair.render.api.events.retrieve({});

Input

Name	Type	Required	Description
`eventId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

Key Value

connectionInfo

keyValue.connectionInfo Retrieve connection info for a Render Key Value instance Risk: read

await corsair.render.api.keyValue.connectionInfo({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

create

keyValue.create Create a Render Key Value instance Risk: write

await corsair.render.api.keyValue.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`plan`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

delete

keyValue.delete Delete a Render Key Value instance Risk: destructive

await corsair.render.api.keyValue.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

list

keyValue.list List Render Key Value instances Risk: read

await corsair.render.api.keyValue.list({});

Input

Name	Type	Required	Description
`name`	`string[]`	No	—
`region`	`frankfurt \| oregon \| ohio \| singapore \| virginia[]`	No	—
`ownerId`	`string[]`	No	—
`environmentId`	`string[]`	No	—
`createdBefore`	`string`	No	—
`createdAfter`	`string`	No	—
`updatedBefore`	`string`	No	—
`updatedAfter`	`string`	No	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
}[]

resume

keyValue.resume Resume a Render Key Value instance Risk: write

await corsair.render.api.keyValue.resume({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

retrieve

keyValue.retrieve Retrieve a Render Key Value instance Risk: read

await corsair.render.api.keyValue.retrieve({});

Input

Name	Type	Required	Description
`redisId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

suspend

keyValue.suspend Suspend a Render Key Value instance Risk: write

await corsair.render.api.keyValue.suspend({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

update

keyValue.update Update a Render Key Value instance Risk: write

await corsair.render.api.keyValue.update({});

Input

Name	Type	Required	Description
`redisId`	`string`	Yes	—
`name`	`string`	No	—
`plan`	`string`	No	—
`maxmemoryPolicy`	`string`	No	—
`persistenceMode`	`string`	No	—
`ipAllowList`	`object[]`	No	—

ipAllowList full type

{
}[]

Output: object[]

Output full type

{
} | {
}[]

Logs

deleteOwnerStream

logs.deleteOwnerStream Delete an owner log stream Risk: destructive

await corsair.render.api.logs.deleteOwnerStream({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

deleteResourceStream

logs.deleteResourceStream Delete a Render resource log stream Risk: destructive

await corsair.render.api.logs.deleteResourceStream({});

Input

Name	Type	Required	Description
`resourceId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

list

logs.list List Render logs Risk: read

await corsair.render.api.logs.list({ ownerId: 'tea-cjnxpkdhshc73d12t9i0', resource: ['srv-d0k1q2r3s4t5u6v7w8x9'], limit: 50 });

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	Yes	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`resource`	`string[]`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

resourceStreams

logs.resourceStreams List resource log streams Risk: read

await corsair.render.api.logs.resourceStreams({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieveOwnerStream

logs.retrieveOwnerStream Retrieve a Render owner log stream Risk: read

await corsair.render.api.logs.retrieveOwnerStream({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

retrieveResourceStream

logs.retrieveResourceStream Retrieve a Render resource log stream Risk: read

await corsair.render.api.logs.retrieveResourceStream({});

Input

Name	Type	Required	Description
`resourceId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

updateOwnerStream

logs.updateOwnerStream Update an owner log stream Risk: write

await corsair.render.api.logs.updateOwnerStream({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`preview`	`send \| drop`	Yes	—
`endpoint`	`string`	No	—
`token`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

updateResourceStream

logs.updateResourceStream Set the log stream setting for one Render resource Risk: write

await corsair.render.api.logs.updateResourceStream({});

Input

Name	Type	Required	Description
`resourceId`	`string`	Yes	—
`setting`	`send \| drop`	Yes	—
`endpoint`	`string`	No	—
`token`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

values

logs.values List Render log values Risk: read

await corsair.render.api.logs.values({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	Yes	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`resource`	`string[]`	Yes	—
`label`	`instance \| host \| statusCode \| method \| level \| type`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

Maintenance

list

maintenance.list List Render maintenance windows Risk: read

await corsair.render.api.maintenance.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

maintenance.retrieve Retrieve a Render maintenance run Risk: read

await corsair.render.api.maintenance.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

trigger

maintenance.trigger Trigger a Render maintenance run Risk: write

await corsair.render.api.maintenance.trigger({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

update

maintenance.update Update a Render maintenance run Risk: write

await corsair.render.api.maintenance.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`scheduledAt`	`string`	No	—

Output: object

Output full type

undefined | | {
}

Metrics

activeConnections

metrics.activeConnections Read active Render connections Risk: read

await corsair.render.api.metrics.activeConnections({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

applicationFilterValues

metrics.applicationFilterValues List Render application metric filter values Risk: read

await corsair.render.api.metrics.applicationFilterValues({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

bandwidth

metrics.bandwidth Read Render bandwidth metrics Risk: read

await corsair.render.api.metrics.bandwidth({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

bandwidthSources

metrics.bandwidthSources Read Render bandwidth sources Risk: read

await corsair.render.api.metrics.bandwidthSources({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

cpu

metrics.cpu Read Render CPU metrics Risk: read

await corsair.render.api.metrics.cpu({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

cpuLimit

metrics.cpuLimit Read Render CPU limits Risk: read

await corsair.render.api.metrics.cpuLimit({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

cpuTarget

metrics.cpuTarget Read Render CPU target metrics Risk: read

await corsair.render.api.metrics.cpuTarget({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

deleteOwnerStream

metrics.deleteOwnerStream Delete the metrics stream of a Render workspace Risk: destructive

await corsair.render.api.metrics.deleteOwnerStream({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

diskCapacity

metrics.diskCapacity Read Render disk capacity Risk: read

await corsair.render.api.metrics.diskCapacity({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

diskUsage

metrics.diskUsage Read Render disk usage Risk: read

await corsair.render.api.metrics.diskUsage({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

httpFilterValues

metrics.httpFilterValues List Render HTTP metric filter values Risk: read

await corsair.render.api.metrics.httpFilterValues({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

httpLatency

metrics.httpLatency Read Render HTTP latency metrics Risk: read

await corsair.render.api.metrics.httpLatency({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

httpRequests

metrics.httpRequests Read Render HTTP request metrics Risk: read

await corsair.render.api.metrics.httpRequests({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

instanceCount

metrics.instanceCount Read Render instance counts Risk: read

await corsair.render.api.metrics.instanceCount({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

memory

metrics.memory Read Render memory metrics Risk: read

await corsair.render.api.metrics.memory({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

memoryLimit

metrics.memoryLimit Read Render memory limits Risk: read

await corsair.render.api.metrics.memoryLimit({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

memoryTarget

metrics.memoryTarget Read Render memory targets Risk: read

await corsair.render.api.metrics.memoryTarget({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

pathFilterValues

metrics.pathFilterValues List Render path metric filter values Risk: read

await corsair.render.api.metrics.pathFilterValues({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

replicationLag

metrics.replicationLag Read Render replication lag metrics Risk: read

await corsair.render.api.metrics.replicationLag({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

retrieveOwnerStream

metrics.retrieveOwnerStream Retrieve metrics stream settings for a Render owner Risk: read

await corsair.render.api.metrics.retrieveOwnerStream({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

taskRunsCompleted

metrics.taskRunsCompleted Read completed Render task run metrics Risk: read

await corsair.render.api.metrics.taskRunsCompleted({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

taskRunsQueued

metrics.taskRunsQueued Read queued Render task run metrics Risk: read

await corsair.render.api.metrics.taskRunsQueued({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

upsertOwnerStream

metrics.upsertOwnerStream Create or update metrics stream settings for a Render owner Risk: write

await corsair.render.api.metrics.upsertOwnerStream({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`provider`	`BETTER_STACK \| GRAFANA \| DATADOG \| NEW_RELIC \| HONEYCOMB \| SIGNOZ \| GROUNDCOVER \| LOGFIRE \| CUSTOM`	No	—
`url`	`string`	No	—
`token`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

Notifications

listOverrides

notifications.listOverrides List per-service notification overrides Risk: read

await corsair.render.api.notifications.listOverrides({});

Input

Name	Type	Required	Description
`ownerId`	`string[]`	No	—
`serviceId`	`string[]`	No	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
}[]

retrieveOwnerSettings

notifications.retrieveOwnerSettings Retrieve notification settings for a Render workspace Risk: read

await corsair.render.api.notifications.retrieveOwnerSettings({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

retrieveServiceOverrides

notifications.retrieveServiceOverrides Retrieve notification overrides for a Render service Risk: read

await corsair.render.api.notifications.retrieveServiceOverrides({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

updateOwnerSettings

notifications.updateOwnerSettings Update notification settings for a Render workspace Risk: write

await corsair.render.api.notifications.updateOwnerSettings({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`emailEnabled`	`boolean`	No	—
`previewNotificationsEnabled`	`boolean`	No	—
`notificationsToSend`	`none \| failure \| all`	No	—

Output: object[]

Output full type

{
} | {
}[]

updateServiceOverrides

notifications.updateServiceOverrides Update notification overrides for a Render service Risk: write

await corsair.render.api.notifications.updateServiceOverrides({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`previewNotificationsEnabled`	`default \| false \| true`	No	—
`notificationsToSend`	`default \| none \| failure \| all`	No	—

Output: object[]

Output full type

{
} | {
}[]

Organizations

auditLogs

organizations.auditLogs List audit logs for a Render organization Risk: read

await corsair.render.api.organizations.auditLogs({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—

Output: object[]

Output full type

{
}[]

Owners

auditLogs

owners.auditLogs List audit logs for a Render owner Risk: read

await corsair.render.api.owners.auditLogs({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`startTime`	`string`	No	—
`endTime`	`string`	No	—

Output: object[]

Output full type

{
}[]

list

owners.list List Render owners Risk: read

await corsair.render.api.owners.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

members

owners.members List Render owner members Risk: read

await corsair.render.api.owners.members({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

removeMember

owners.removeMember Remove a member from a Render workspace Risk: destructive

await corsair.render.api.owners.removeMember({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`userId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

retrieve

owners.retrieve Retrieve a Render owner Risk: read

await corsair.render.api.owners.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

updateMember

owners.updateMember Update a Render workspace member role Risk: write

await corsair.render.api.owners.updateMember({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`userId`	`string`	Yes	—
`role`	`ADMIN \| DEVELOPER \| WORKSPACE_CONTRIBUTOR \| WORKSPACE_BILLING \| WORKSPACE_VIEWER`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

Postgres

connectionInfo

postgres.connectionInfo Retrieve connection info for a Render Postgres instance Risk: read

await corsair.render.api.postgres.connectionInfo({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

create

postgres.create Create a Render Postgres database Risk: write

await corsair.render.api.postgres.create({ name: 'orders-db', ownerId: 'tea-cjnxpkdhshc73d12t9i0', plan: 'basic_256mb', version: '17' });

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`plan`	`string`	Yes	—
`version`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

createExport

postgres.createExport Create an export of a Render Postgres database Risk: write

await corsair.render.api.postgres.createExport({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

createUser

postgres.createUser Create a user for a Render Postgres database Risk: write

await corsair.render.api.postgres.createUser({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`body`	`object`	Yes	—

body full type

{
  username: string
}

Output: object[]

Output full type

{
} | {
}[]

delete

postgres.delete Delete a Render Postgres database Risk: destructive

await corsair.render.api.postgres.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

deleteUser

postgres.deleteUser Delete a user on a Render Postgres instance Risk: destructive

await corsair.render.api.postgres.deleteUser({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`username`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

failover

postgres.failover Trigger a failover for a Render Postgres instance Risk: write

await corsair.render.api.postgres.failover({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

list

postgres.list List Render Postgres databases Risk: read

await corsair.render.api.postgres.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

listExports

postgres.listExports List exports of a Render Postgres database Risk: read

await corsair.render.api.postgres.listExports({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

listUsers

postgres.listUsers List users of a Render Postgres database Risk: read

await corsair.render.api.postgres.listUsers({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

processes

postgres.processes List active queries for a Render Postgres database Risk: read

await corsair.render.api.postgres.processes({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`processes`	`object[]`	Yes	—

processes full type

{
}[]

recover

postgres.recover Trigger point-in-time recovery for a Render Postgres instance Risk: write

await corsair.render.api.postgres.recover({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`restoreName`	`string`	No	—
`restoreTime`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

recoveryInfo

postgres.recoveryInfo Retrieve point-in-time recovery status for a Render Postgres instance Risk: read

await corsair.render.api.postgres.recoveryInfo({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

restart

postgres.restart Restart a Render Postgres instance Risk: write

await corsair.render.api.postgres.restart({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

resume

postgres.resume Resume a Render Postgres instance Risk: write

await corsair.render.api.postgres.resume({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

retrieve

postgres.retrieve Retrieve a Render Postgres database Risk: read

await corsair.render.api.postgres.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

sizes

postgres.sizes List database sizes for a Render Postgres database Risk: read

await corsair.render.api.postgres.sizes({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`sizes`	`object[]`	Yes	—

sizes full type

{
}[]

suspend

postgres.suspend Suspend a Render Postgres instance Risk: write

await corsair.render.api.postgres.suspend({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

undefined | | {
}

tableScans

postgres.tableScans List table scans for a Render Postgres database Risk: read

await corsair.render.api.postgres.tableScans({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`tableScans`	`object[]`	Yes	—

tableScans full type

{
}[]

topQueries

postgres.topQueries List top queries for a Render Postgres database Risk: read

await corsair.render.api.postgres.topQueries({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`topQueries`	`object[]`	Yes	—

topQueries full type

{
}[]

update

postgres.update Update a Render Postgres database Risk: write

await corsair.render.api.postgres.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

Projects

create

projects.create Create a Render project Risk: write

await corsair.render.api.projects.create({ name: 'storefront', ownerId: 'tea-cjnxpkdhshc73d12t9i0', environments: [{ name: 'production' }] });

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`environments`	`object[]`	Yes	—

environments full type

{
  name: string
}[]

Output: object[]

Output full type

{
} | {
}[]

delete

projects.delete Delete a Render project Risk: destructive

await corsair.render.api.projects.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

list

projects.list List Render projects Risk: read

await corsair.render.api.projects.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

projects.retrieve Retrieve a Render project Risk: read

await corsair.render.api.projects.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

projects.update Update a Render project Risk: write

await corsair.render.api.projects.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

Registry Credentials

create

registryCredentials.create Create registry credentials Risk: write

await corsair.render.api.registryCredentials.create({});

Input

Name	Type	Required	Description
`registry`	`GITHUB \| GITLAB \| DOCKER \| GOOGLE_ARTIFACT \| AWS_ECR`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	Yes	—
`authToken`	`string`	Yes	—
`ownerId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

delete

registryCredentials.delete Delete registry credentials Risk: destructive

await corsair.render.api.registryCredentials.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

list

registryCredentials.list List registry credentials Risk: read

await corsair.render.api.registryCredentials.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

registryCredentials.retrieve Retrieve registry credentials Risk: read

await corsair.render.api.registryCredentials.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

registryCredentials.update Update registry credentials Risk: write

await corsair.render.api.registryCredentials.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`registry`	`GITHUB \| GITLAB \| DOCKER \| GOOGLE_ARTIFACT \| AWS_ECR`	Yes	—
`name`	`string`	Yes	—
`username`	`string`	Yes	—
`authToken`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

Services

cancelDeploy

services.cancelDeploy Cancel a Render deployment Risk: write

await corsair.render.api.services.cancelDeploy({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`deployId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`string`	No	—
`buildId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`finishedAt`	`string`	No	—

create

services.create Create a Render service Risk: write

await corsair.render.api.services.create({});

Input

Name	Type	Required	Description
`type`	`string`	Yes	—
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

createPreview

services.createPreview Create an image-backed preview for a Render service Risk: write

await corsair.render.api.services.createPreview({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`imagePath`	`string`	Yes	—
`name`	`string`	No	—
`plan`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

cronJobs.cancelRun

services.cronJobs.cancelRun Cancel a run of a Render cron job Risk: destructive

await corsair.render.api.services.cronJobs.cancelRun({});

Input

Name	Type	Required	Description
`cronJobId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

cronJobs.triggerRun

services.cronJobs.triggerRun Trigger a run of a Render cron job Risk: write

await corsair.render.api.services.cronJobs.triggerRun({});

Input

Name	Type	Required	Description
`cronJobId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`string`	Yes	—
`startedAt`	`string`	No	—
`finishedAt`	`string`	No	—
`triggeredBy`	`string`	No	—

customDomains.create

services.customDomains.create Add a custom domain to a Render service Risk: write

await corsair.render.api.services.customDomains.create({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`name`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

customDomains.delete

services.customDomains.delete Delete a custom domain from a Render service Risk: destructive

await corsair.render.api.services.customDomains.delete({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`customDomainNameOrID`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

customDomains.list

services.customDomains.list List custom domains for a Render service Risk: read

await corsair.render.api.services.customDomains.list({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`name`	`string[]`	No	—
`domainType`	`apex \| subdomain`	No	—
`verificationStatus`	`verified \| unverified`	No	—
`createdBefore`	`string`	No	—
`createdAfter`	`string`	No	—

Output: object[]

Output full type

{
}[]

customDomains.retrieve

services.customDomains.retrieve Retrieve a custom domain on a Render service Risk: read

await corsair.render.api.services.customDomains.retrieve({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`customDomainNameOrID`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

customDomains.verify

services.customDomains.verify Re-run DNS verification for a custom domain on a Render service Risk: write

await corsair.render.api.services.customDomains.verify({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`customDomainNameOrID`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

delete

services.delete Delete a Render service Risk: destructive

await corsair.render.api.services.delete({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

deleteAutoscaling

services.deleteAutoscaling Delete autoscaling configuration for a Render service Risk: destructive

await corsair.render.api.services.deleteAutoscaling({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envGroups.create

services.envGroups.create Create a Render environment group Risk: write

await corsair.render.api.services.envGroups.create({ name: 'shared-config', ownerId: 'tea-cjnxpkdhshc73d12t9i0', envVars: [{ key: 'LOG_LEVEL', value: 'info' }] });

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`envVars`	`object[]`	Yes	—
`secretFiles`	`object[]`	No	—
`serviceIds`	`string[]`	No	—
`environmentId`	`string`	No	—

envVars full type

(
  {
    key: string,
    value: string
  } | {
    key: string,
    generateValue: boolean
  }
)[]

secretFiles full type

{
  name: string,
  content: string
}[]

Output: object[]

Output full type

{
} | {
}[]

envGroups.delete

services.envGroups.delete Delete a Render environment group Risk: destructive

await corsair.render.api.services.envGroups.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

envGroups.envVars.delete

services.envGroups.envVars.delete Delete one environment variable from a Render env group Risk: destructive

await corsair.render.api.services.envGroups.envVars.delete({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envGroups.envVars.retrieve

services.envGroups.envVars.retrieve Retrieve one environment variable, including its value, from a Render env group Risk: read

await corsair.render.api.services.envGroups.envVars.retrieve({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.envVars.upsert

services.envGroups.envVars.upsert Add or update one environment variable in a Render env group Risk: write

await corsair.render.api.services.envGroups.envVars.upsert({ envGroupId: 'evg-d0k1q2r3s4t5u6v7w8x9', envVarKey: 'LOG_LEVEL', value: 'info' });

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—
`value`	`string`	No	—
`generateValue`	`boolean`	No	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.linkService

services.envGroups.linkService Link a Render service to an env group Risk: write

await corsair.render.api.services.envGroups.linkService({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`serviceId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.list

services.envGroups.list List Render environment groups Risk: read

await corsair.render.api.services.envGroups.list({});

Input

Name	Type	Required	Description
`name`	`string[]`	No	—
`ownerId`	`string[]`	No	—
`environmentId`	`string[]`	No	—
`createdBefore`	`string`	No	—
`createdAfter`	`string`	No	—
`updatedBefore`	`string`	No	—
`updatedAfter`	`string`	No	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
}[]

envGroups.retrieve

services.envGroups.retrieve Retrieve a Render environment group Risk: read

await corsair.render.api.services.envGroups.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.secretFiles.delete

services.envGroups.secretFiles.delete Delete one secret file from a Render env group Risk: destructive

await corsair.render.api.services.envGroups.secretFiles.delete({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`secretFileName`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envGroups.secretFiles.retrieve

services.envGroups.secretFiles.retrieve Retrieve one secret file, including its contents, from a Render env group Risk: read

await corsair.render.api.services.envGroups.secretFiles.retrieve({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`secretFileName`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.secretFiles.upsert

services.envGroups.secretFiles.upsert Add or update one secret file in a Render env group Risk: write

await corsair.render.api.services.envGroups.secretFiles.upsert({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`secretFileName`	`string`	Yes	—
`content`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envGroups.unlinkService

services.envGroups.unlinkService Unlink a Render service from an environment group Risk: destructive

await corsair.render.api.services.envGroups.unlinkService({});

Input

Name	Type	Required	Description
`envGroupId`	`string`	Yes	—
`serviceId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envGroups.update

services.envGroups.update Update a Render environment group Risk: write

await corsair.render.api.services.envGroups.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

environments.addResources

services.environments.addResources Move services, databases or env groups into a Render environment Risk: write

await corsair.render.api.services.environments.addResources({});

Input

Name	Type	Required	Description
`environmentId`	`string`	Yes	—
`resourceIds`	`string[]`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

environments.create

services.environments.create Create a Render environment Risk: write

await corsair.render.api.services.environments.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`projectId`	`string`	Yes	—
`protectedStatus`	`unprotected \| protected`	No	—
`networkIsolationEnabled`	`boolean`	No	—

Output: object[]

Output full type

{
} | {
}[]

environments.delete

services.environments.delete Delete a Render environment Risk: destructive

await corsair.render.api.services.environments.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

environments.list

services.environments.list List Render environments Risk: read

await corsair.render.api.services.environments.list({ projectId: 'prj-d0k1q2r3s4t5u6v7w8x9' });

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	Yes	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

environments.removeResources

services.environments.removeResources Remove resources from a Render environment Risk: destructive

await corsair.render.api.services.environments.removeResources({ environmentId: 'evm-d0k1q2r3s4t5u6v7w8x9', resourceIds: ['srv-d0k1q2r3s4t5u6v7w8x9'] });

Input

Name	Type	Required	Description
`environmentId`	`string`	Yes	—
`resourceIds`	`string[]`	Yes	—

Output: object

Output full type

{
} | undefined

environments.retrieve

services.environments.retrieve Retrieve a Render environment Risk: read

await corsair.render.api.services.environments.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

environments.update

services.environments.update Update a Render environment Risk: write

await corsair.render.api.services.environments.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

envVars.delete

services.envVars.delete Delete an environment variable from a Render service Risk: destructive

await corsair.render.api.services.envVars.delete({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

envVars.list

services.envVars.list List environment variables for a Render service Risk: read

await corsair.render.api.services.envVars.list({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

envVars.retrieve

services.envVars.retrieve Retrieve one environment variable, including its value, from a Render service Risk: read

await corsair.render.api.services.envVars.retrieve({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

envVars.update

services.envVars.update Replace all environment variables on a Render service with the given list; variables not listed are deleted Risk: destructive

await corsair.render.api.services.envVars.update({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', body: [{ key: 'LOG_LEVEL', value: 'info' }, { key: 'SESSION_SECRET', generateValue: true }] });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`body`	`object[]`	Yes	—

body full type

(
  {
    key: string,
    value: string
  } | {
    key: string,
    generateValue: boolean
  }
)[]

Output: object[]

Output full type

{
} | {
}[]

envVars.upsert

services.envVars.upsert Add or update one environment variable on a Render service Risk: write

await corsair.render.api.services.envVars.upsert({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', envVarKey: 'LOG_LEVEL', value: 'debug' });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`envVarKey`	`string`	Yes	—
`value`	`string`	No	—
`generateValue`	`boolean`	No	—

Output: object[]

Output full type

{
} | {
}[]

headers.add

services.headers.add Add a response header rule to a Render service Risk: write

await corsair.render.api.services.headers.add({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`path`	`string`	Yes	—
`name`	`string`	Yes	—
`value`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

headers.delete

services.headers.delete Delete a header from a Render service Risk: destructive

await corsair.render.api.services.headers.delete({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`headerId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

headers.list

services.headers.list List headers for a Render service Risk: read

await corsair.render.api.services.headers.list({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`path`	`string[]`	No	—
`name`	`string[]`	No	—
`value`	`string[]`	No	—

Output: object[]

Output full type

{
}[]

headers.update

services.headers.update Replace all response header rules on a Render service with the given list; rules not listed are deleted Risk: destructive

await corsair.render.api.services.headers.update({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`body`	`object[]`	Yes	—

body full type

{
  path: string,
  name: string,
  value: string
}[]

Output: object[]

Output full type

{
} | {
}[]

jobs.cancel

services.jobs.cancel Cancel a running job on a Render service Risk: write

await corsair.render.api.services.jobs.cancel({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`jobId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

jobs.create

services.jobs.create Create a job run for a Render service Risk: write

await corsair.render.api.services.jobs.create({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`startCommand`	`string`	Yes	—
`planId`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

jobs.list

services.jobs.list List jobs for a Render service Risk: read

await corsair.render.api.services.jobs.list({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

jobs.retrieve

services.jobs.retrieve Retrieve a Render service job Risk: read

await corsair.render.api.services.jobs.retrieve({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`jobId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

list

services.list List Render services accessible to the authenticated owner Risk: read

await corsair.render.api.services.list({ type: ['web_service'], region: ['oregon'], limit: 20 });

Input

Name	Type	Required	Description
`name`	`string[]`	No	—
`type`	`string[]`	No	—
`environmentId`	`string[]`	No	—
`env`	`string[]`	No	—
`region`	`string[]`	No	—
`suspended`	`suspended \| not_suspended[]`	No	—
`ownerId`	`string[]`	No	—
`includePreviews`	`boolean`	No	—
`createdBefore`	`string`	No	—
`createdAfter`	`string`	No	—
`updatedBefore`	`string`	No	—
`updatedAfter`	`string`	No	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
  service: {
    id: string,
    name: string,
    type: string,
    ownerId: string,
    environmentId?: string | null,
    createdAt?: string,
    updatedAt?: string
  },
  cursor?: string
}[]

listDeploys

services.listDeploys List deployments for a Render service Risk: read

await corsair.render.api.services.listDeploys({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', status: ['live'], limit: 10 });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`status`	`string[]`	No	—
`createdBefore`	`string`	No	—
`createdAfter`	`string`	No	—
`updatedBefore`	`string`	No	—
`updatedAfter`	`string`	No	—
`finishedBefore`	`string`	No	—
`finishedAfter`	`string`	No	—
`cursor`	`string`	No	—
`limit`	`number`	No	—

Output: object[]

Output full type

{
}[]

listEvents

services.listEvents List events for a Render service Risk: read

await corsair.render.api.services.listEvents({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

listInstances

services.listInstances List the running instances of a Render service Risk: read

await corsair.render.api.services.listInstances({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object[]

Output full type

{
}[]

listOutboundIps

services.listOutboundIps List outbound IPs for a Render service Risk: read

await corsair.render.api.services.listOutboundIps({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output

Name	Type	Required	Description
`type`	`string`	Yes	—
`dedicatedIpId`	`string`	No	—
`ips`	`string[]`	Yes	—

purgeCache

services.purgeCache Purge the cache for a Render service Risk: write

await corsair.render.api.services.purgeCache({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object

Output full type

undefined | | {
}

restart

services.restart Restart a Render service Risk: write

await corsair.render.api.services.restart({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object

Output full type

undefined | | {
}

resume

services.resume Resume a Render service Risk: write

await corsair.render.api.services.resume({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object

Output full type

undefined | | {
}

retrieve

services.retrieve Retrieve a Render service Risk: read

await corsair.render.api.services.retrieve({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9' });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`type`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`environmentId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

retrieveDeploy

services.retrieveDeploy Retrieve one deploy of a Render service Risk: read

await corsair.render.api.services.retrieveDeploy({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', deployId: 'dep-d0k1q2r3s4t5u6v7w8y0' });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`deployId`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

rollbackDeploy

services.rollbackDeploy Roll back a Render service deployment Risk: write

await corsair.render.api.services.rollbackDeploy({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', deployId: 'dep-d0k1q2r3s4t5u6v7w8y0' });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`deployId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`status`	`string`	No	—
`buildId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—
`finishedAt`	`string`	No	—

routes.add

services.routes.add Add a redirect or rewrite rule to a Render service Risk: write

await corsair.render.api.services.routes.add({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`type`	`redirect \| rewrite`	Yes	—
`source`	`string`	Yes	—
`destination`	`string`	Yes	—
`priority`	`number`	No	—

Output: object[]

Output full type

{
} | {
}[]

routes.delete

services.routes.delete Delete a route from a Render service Risk: destructive

await corsair.render.api.services.routes.delete({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`routeId`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

routes.list

services.routes.list List the redirect and rewrite rules of a Render service Risk: read

await corsair.render.api.services.routes.list({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`type`	`redirect \| rewrite[]`	No	—
`source`	`string[]`	No	—
`destination`	`string[]`	No	—

Output: object[]

Output full type

{
}[]

routes.update

services.routes.update Replace all redirect and rewrite rules on a Render service with the given list; rules not listed are deleted Risk: destructive

await corsair.render.api.services.routes.update({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', body: [{ type: 'rewrite', source: '/app/*', destination: '/index.html' }] });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`body`	`object[]`	Yes	—

body full type

{
  type: redirect | rewrite,
  source: string,
  destination: string
}[]

Output: object[]

Output full type

{
} | {
}[]

routes.updatePriority

services.routes.updatePriority Change the priority of one redirect or rewrite rule on a Render service Risk: write

await corsair.render.api.services.routes.updatePriority({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`routeId`	`string`	Yes	—
`priority`	`number`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

scale

services.scale Scale a Render service to a fixed instance count Risk: write

await corsair.render.api.services.scale({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', numInstances: 2 });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`numInstances`	`number`	Yes	—

Output: object

Output full type

undefined | | {
}

secretFiles.delete

services.secretFiles.delete Delete one secret file from a Render service Risk: destructive

await corsair.render.api.services.secretFiles.delete({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`secretFileName`	`string`	Yes	—

Output: object

Output full type

{
} | undefined

secretFiles.list

services.secretFiles.list List secret files on a Render service, including their contents Risk: read

await corsair.render.api.services.secretFiles.list({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

secretFiles.retrieve

services.secretFiles.retrieve Retrieve one secret file, including its contents, from a Render service Risk: read

await corsair.render.api.services.secretFiles.retrieve({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`secretFileName`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

secretFiles.update

services.secretFiles.update Replace all secret files on a Render service with the given list; files not listed are deleted Risk: destructive

await corsair.render.api.services.secretFiles.update({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`body`	`object[]`	Yes	—

body full type

{
  name: string,
  content: string
}[]

Output: object[]

Output full type

{
} | {
}[]

secretFiles.upsert

services.secretFiles.upsert Add or update one secret file on a Render service Risk: write

await corsair.render.api.services.secretFiles.upsert({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`secretFileName`	`string`	Yes	—
`content`	`string`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

suspend

services.suspend Suspend a Render service Risk: write

await corsair.render.api.services.suspend({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—

Output: object

Output full type

undefined | | {
}

triggerDeploy

services.triggerDeploy Trigger a Render deployment Risk: write

await corsair.render.api.services.triggerDeploy({ serviceId: 'srv-d0k1q2r3s4t5u6v7w8x9', clearCache: 'clear' });

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`commitId`	`string`	No	—
`buildId`	`string`	No	—
`clearCache`	`clear \| do_not_clear`	No	—
`imageUrl`	`string`	No	—
`deployMode`	`deploy_only \| build_and_deploy`	No	—

Output: object

Output full type

{
  id: string,
  status?: string,
  buildId?: string,
  createdAt?: string,
  updatedAt?: string,
  finishedAt?: string
} | undefined | | {
}

update

services.update Update a Render service Risk: write

await corsair.render.api.services.update({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`name`	`string`	No	—
`autoDeployTrigger`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`type`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`environmentId`	`string`	No	—
`createdAt`	`string`	No	—
`updatedAt`	`string`	No	—

updateAutoscaling

services.updateAutoscaling Update autoscaling for a Render service Risk: write

await corsair.render.api.services.updateAutoscaling({});

Input

Name	Type	Required	Description
`serviceId`	`string`	Yes	—
`enabled`	`boolean`	Yes	—
`min`	`number`	Yes	—
`max`	`number`	Yes	—
`criteria`	`object`	Yes	—

criteria full type

{
  cpu: {
    enabled: boolean,
    percentage: number
  },
  memory: {
    enabled: boolean,
    percentage: number
  }
}

Output: object[]

Output full type

{
} | {
}[]

User

get

user.get Retrieve the authenticated Render user Risk: read

await corsair.render.api.user.get({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

Webhooks

create

webhooks.create Create a webhook for a Render owner Risk: write

await corsair.render.api.webhooks.create({});

Input

Name	Type	Required	Description
`ownerId`	`string`	Yes	—
`name`	`string`	Yes	—
`url`	`string`	Yes	—
`enabled`	`boolean`	Yes	—
`eventFilter`	`string[]`	Yes	—

Output: object[]

Output full type

{
} | {
}[]

delete

webhooks.delete Delete a Render webhook Risk: destructive

await corsair.render.api.webhooks.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

list

webhooks.list List Render webhooks Risk: read

await corsair.render.api.webhooks.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

listEvents

webhooks.listEvents List delivery events for a Render webhook Risk: read

await corsair.render.api.webhooks.listEvents({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`sentBefore`	`string`	No	—
`sentAfter`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

webhooks.retrieve Retrieve a Render webhook Risk: read

await corsair.render.api.webhooks.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

webhooks.update Update a Render webhook Risk: write

await corsair.render.api.webhooks.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`url`	`string`	No	—
`enabled`	`boolean`	No	—
`eventFilter`	`string[]`	No	—

Output: object[]

Output full type

{
} | {
}[]

Workflows

create

workflows.create Create a Render workflow Risk: write

await corsair.render.api.workflows.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`ownerId`	`string`	Yes	—
`region`	`frankfurt \| oregon \| ohio \| singapore \| virginia`	Yes	—
`runCommand`	`string`	Yes	—
`buildConfig`	`object`	Yes	—

buildConfig full type

{
  repo: string,
  buildCommand: string,
  runtime: elixir | go | node | python | ruby,
  branch?: string,
  rootDir?: string
}

Output: object[]

Output full type

{
} | {
}[]

delete

workflows.delete Delete a Render workflow Risk: destructive

await corsair.render.api.workflows.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

list

workflows.list List Render workflows Risk: read

await corsair.render.api.workflows.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

retrieve

workflows.retrieve Retrieve a Render workflow Risk: read

await corsair.render.api.workflows.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

taskRuns.cancel

workflows.taskRuns.cancel Cancel a Render workflow task run Risk: destructive

await corsair.render.api.workflows.taskRuns.cancel({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object

Output full type

{
} | undefined

taskRuns.create

workflows.taskRuns.create Start a Render workflow task run Risk: write

await corsair.render.api.workflows.taskRuns.create({ task: 'my-workflow/send-report', input: ['weekly'] });

Input

Name	Type	Required	Description
`task`	`string`	Yes	—
`input`	`object`	Yes	—
`idempotencyKey`	`string`	No	—

input full type

any[] | {
}

Output: object[]

Output full type

{
} | {
}[]

taskRuns.list

workflows.taskRuns.list List Render task runs Risk: read

await corsair.render.api.workflows.taskRuns.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

taskRuns.retrieve

workflows.taskRuns.retrieve Retrieve a Render workflow task run Risk: read

await corsair.render.api.workflows.taskRuns.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

tasks.list

workflows.tasks.list List Render tasks Risk: read

await corsair.render.api.workflows.tasks.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

tasks.retrieve

workflows.tasks.retrieve Retrieve a Render workflow task Risk: read

await corsair.render.api.workflows.tasks.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

update

workflows.update Update a Render workflow Risk: write

await corsair.render.api.workflows.update({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`body`	`object`	Yes	—

body full type

{
}

Output: object[]

Output full type

{
} | {
}[]

versions.create

workflows.versions.create Create and deploy a Render workflow version Risk: write

await corsair.render.api.workflows.versions.create({});

Input

Name	Type	Required	Description
`workflowId`	`string`	Yes	—
`commit`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

versions.list

workflows.versions.list List Render workflow versions Risk: read

await corsair.render.api.workflows.versions.list({});

Input

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
}[]

versions.retrieve

workflows.versions.retrieve Retrieve a Render workflow version Risk: read

await corsair.render.api.workflows.versions.retrieve({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	No	—
`ownerId`	`string`	No	—
`projectId`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output: object[]

Output full type

{
} | {
}[]

​Blueprints

​disconnect

​list

​listSyncs

​retrieve

​update

​validate

​Build Sources

​builds.list

​builds.retrieve

​builds.trigger

​create

​delete

​envGroups.link

​envGroups.unlink

​envVars.delete

​envVars.list

​envVars.retrieve

​envVars.update

​envVars.upsert

​list

​retrieve

​secretFiles.delete

​secretFiles.list

​secretFiles.retrieve

​secretFiles.update

​secretFiles.upsert

​update

​Dedicated Ips

​create

​delete

​list

​retrieve

​update

​Disks

​create

​delete

​list

​listSnapshots

​restoreSnapshot

​retrieve

​update

​Events

​retrieve

​Key Value

​connectionInfo

​create

​delete

​list

​resume

​retrieve

​suspend

​update

​Logs

​deleteOwnerStream

​deleteResourceStream

​list

​resourceStreams

​retrieveOwnerStream

​retrieveResourceStream

​updateOwnerStream

​updateResourceStream

​values

​Maintenance

​list

​retrieve

​trigger

​update

​Metrics

​activeConnections

​applicationFilterValues

​bandwidth

​bandwidthSources

​cpu

​cpuLimit

​cpuTarget

​deleteOwnerStream

​diskCapacity

​diskUsage

​httpFilterValues

Blueprints

disconnect

list

listSyncs

retrieve

update

validate

Build Sources

builds.list

builds.retrieve

builds.trigger

create

delete

envGroups.link

envGroups.unlink

envVars.delete

envVars.list

envVars.retrieve

envVars.update

envVars.upsert

list

retrieve

secretFiles.delete

secretFiles.list

secretFiles.retrieve

secretFiles.update

secretFiles.upsert

update

Dedicated Ips

create

delete

list

retrieve

update

Disks

create

delete

list

listSnapshots

restoreSnapshot

retrieve

update

Events

retrieve

Key Value

connectionInfo

create

delete

list

resume

retrieve

suspend

update

Logs

deleteOwnerStream

deleteResourceStream

list

resourceStreams

retrieveOwnerStream

retrieveResourceStream

updateOwnerStream

updateResourceStream

values

Maintenance

list

retrieve

trigger

update

Metrics

activeConnections

applicationFilterValues

bandwidth

bandwidthSources

cpu

cpuLimit

cpuTarget

deleteOwnerStream

diskCapacity

diskUsage

httpFilterValues