API

Every northflank.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.

Addon Types

list

addonTypes.list List available Northflank addon types Risk: read

await corsair.northflank.api.addonTypes.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  addonTypes: {
    type: string,
    name: string,
    description?: string,
    features?: {
    },
    resources?: {
    },
    versions?: string[],
    majors?: string[]
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

Cloud Providers

listNodeTypes

cloudProviders.listNodeTypes List supported cloud provider node types Risk: read

await corsair.northflank.api.cloudProviders.listNodeTypes({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—
`provider`	`string`	No	—
`region`	`string`	No	—
`family`	`string`	No	—
`maxGenerationAge`	`number`	No	—
`hasGpu`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  nodeTypes: {
    id: string,
    name: string,
    family?: string | null,
    processorFamily?: string | null,
    workloadType?: string | null,
    generationAge?: number | null,
    provider?: string | null,
    resources?: {
      vcpu?: number | null,
      memory?: number | null
    }
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

listRegions

cloudProviders.listRegions List supported cloud provider regions Risk: read

await corsair.northflank.api.cloudProviders.listRegions({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—
`provider`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  regions: {
    id: string,
    name: string,
    regionName?: string,
    provider?: string,
    availabilityZones?: {
      id: string,
      name: string
    }[]
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

Misc

getDnsId

misc.getDnsId Get the DNS identifier for the authenticated account Risk: read

await corsair.northflank.api.misc.getDnsId({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  dns: string
}

Pipelines

list

pipelines.list List pipelines in a Northflank project Risk: read

await corsair.northflank.api.pipelines.list({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  pipelines: {
    id: string,
    name?: string,
    description?: string,
    createdAt?: string,
    updatedAt?: string
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

Plans

list

plans.list List available Northflank resource plans Risk: read

await corsair.northflank.api.plans.list({});

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  plans: {
    id: string,
    name: string,
    currency?: string,
    amountPerMonth?: number,
    amountPerHour?: number
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

Projects

create

projects.create Create a new Northflank project Risk: write

await corsair.northflank.api.projects.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`description`	`string`	No	—
`region`	`string`	No	—
`clusterId`	`string`	No	—
`color`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  name: string,
  description?: string,
  color?: string,
  region?: string,
  clusterId?: string,
  createdAt?: string,
  updatedAt?: string
}

createOrUpdate

projects.createOrUpdate Create or update a Northflank project (upsert) Risk: write

await corsair.northflank.api.projects.createOrUpdate({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`description`	`string`	No	—
`color`	`string`	No	—
`region`	`string`	No	—
`clusterId`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  name: string,
  description?: string,
  color?: string,
  region?: string,
  clusterId?: string,
  createdAt?: string,
  updatedAt?: string
}

delete

projects.delete Delete a Northflank project Risk: write

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

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`delete_child_objects`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
}

get

projects.get Get details of a Northflank project Risk: read

await corsair.northflank.api.projects.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  name: string,
  description?: string,
  color?: string,
  region?: string,
  clusterId?: string,
  createdAt?: string,
  updatedAt?: string
}

list

projects.list List Northflank projects Risk: read

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

Input

Name	Type	Required	Description
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  projects: {
    id: string,
    name: string,
    description?: string,
    color?: string,
    region?: string,
    clusterId?: string,
    createdAt?: string,
    updatedAt?: string
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

update

projects.update Update an existing Northflank project Risk: write

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

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`description`	`string`	No	—
`color`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  name: string,
  description?: string,
  color?: string,
  region?: string,
  clusterId?: string,
  createdAt?: string,
  updatedAt?: string
}

Regions

list

regions.list List available Northflank regions Risk: read

await corsair.northflank.api.regions.list({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  regions: {
    id: string,
    name: string,
    regionName?: string
  }[]
}

Secrets

create

secrets.create Create a new secret group in a Northflank project Risk: write

await corsair.northflank.api.secrets.create({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`stageId`	`string`	No	—
`tags`	`string[]`	No	—
`type`	`secret \| config`	No	—
`secretType`	`environment-arguments \| environment \| arguments`	Yes	—
`priority`	`number`	Yes	—
`restrictions`	`object`	No	—
`addonDependencies`	`object[]`	No	—
`externalAddonDependencies`	`object[]`	No	—
`secrets`	`object`	No	—

restrictions full type

{
  restricted?: boolean,
  nfObjects?: {
    id: string,
    type: service | job
  }[],
  tags?: string[],
  tagMatchCondition?: and | or,
  stageIds?: string[]
}

addonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

externalAddonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

secrets full type

{
  variables?: {
  },
  files?: {
  },
  dockerSecretMounts?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  projectId?: string,
  name: string,
  description?: string,
  tags?: string[],
  type?: secret | config,
  secretType?: environment-arguments | environment | arguments,
  priority?: number,
  restrictions?: {
    restricted?: boolean,
    nfObjects?: {
      id: string,
      type: service | job
    }[],
    tags?: string[],
    tagMatchCondition?: and | or,
    stageIds?: string[]
  },
  secrets?: {
    variables?: {
    },
    files?: {
    },
    dockerSecretMounts?: {
    }
  },
  createdAt?: string,
  updatedAt?: string
}

createOrUpdate

secrets.createOrUpdate Create or update a secret group in a Northflank project Risk: write

await corsair.northflank.api.secrets.createOrUpdate({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`name`	`string`	Yes	—
`description`	`string`	No	—
`stageId`	`string`	No	—
`tags`	`string[]`	No	—
`type`	`secret \| config`	No	—
`secretType`	`environment-arguments \| environment \| arguments`	Yes	—
`priority`	`number`	Yes	—
`restrictions`	`object`	No	—
`addonDependencies`	`object[]`	No	—
`externalAddonDependencies`	`object[]`	No	—
`secrets`	`object`	No	—

restrictions full type

{
  restricted?: boolean,
  nfObjects?: {
    id: string,
    type: service | job
  }[],
  tags?: string[],
  tagMatchCondition?: and | or,
  stageIds?: string[]
}

addonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

externalAddonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

secrets full type

{
  variables?: {
  },
  files?: {
  },
  dockerSecretMounts?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  projectId?: string,
  name: string,
  description?: string,
  tags?: string[],
  type?: secret | config,
  secretType?: environment-arguments | environment | arguments,
  priority?: number,
  restrictions?: {
    restricted?: boolean,
    nfObjects?: {
      id: string,
      type: service | job
    }[],
    tags?: string[],
    tagMatchCondition?: and | or,
    stageIds?: string[]
  },
  secrets?: {
    variables?: {
    },
    files?: {
    },
    dockerSecretMounts?: {
    }
  },
  createdAt?: string,
  updatedAt?: string
}

get

secrets.get Get details of a Northflank secret group Risk: read

await corsair.northflank.api.secrets.get({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`secretId`	`string`	Yes	—
`show`	`this \| inherited \| all`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  projectId?: string,
  name: string,
  description?: string,
  tags?: string[],
  type?: secret | config,
  secretType?: environment-arguments | environment | arguments,
  priority?: number,
  restrictions?: {
    restricted?: boolean,
    nfObjects?: {
      id: string,
      type: service | job
    }[],
    tags?: string[],
    tagMatchCondition?: and | or,
    stageIds?: string[]
  },
  secrets?: {
    variables?: {
    },
    files?: {
    },
    dockerSecretMounts?: {
    }
  },
  createdAt?: string,
  updatedAt?: string
}

getDetails

secrets.getDetails Get a secret group with linked addon details Risk: read

await corsair.northflank.api.secrets.getDetails({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`secretId`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  projectId?: string,
  name: string,
  description?: string,
  tags?: string[],
  type?: secret | config,
  secretType?: environment-arguments | environment | arguments,
  priority?: number,
  restrictions?: {
    restricted?: boolean,
    nfObjects?: {
      id: string,
      type: service | job
    }[],
    tags?: string[],
    tagMatchCondition?: and | or,
    stageIds?: string[]
  },
  secrets?: {
    variables?: {
    },
    files?: {
    },
    dockerSecretMounts?: {
    }
  },
  createdAt?: string,
  updatedAt?: string,
  addonSecrets?: {
    id: string,
    name: string,
    addonType: string,
    version: string,
    variables?: {
    }
  }[]
}

list

secrets.list List secret groups in a Northflank project Risk: read

await corsair.northflank.api.secrets.list({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  secrets: {
    id: string,
    projectId?: string,
    name: string,
    description?: string,
    tags?: string[],
    type?: secret | config,
    secretType?: environment-arguments | environment | arguments,
    priority?: number,
    restrictions?: {
      restricted?: boolean,
      nfObjects?: {
        id: string,
        type: service | job
      }[],
      tags?: string[],
      tagMatchCondition?: and | or,
      stageIds?: string[]
    },
    secrets?: {
      variables?: {
      },
      files?: {
      },
      dockerSecretMounts?: {
      }
    },
    createdAt?: string,
    updatedAt?: string
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

patch

secrets.patch Partially update a secret group in a Northflank project Risk: write

await corsair.northflank.api.secrets.patch({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`secretId`	`string`	Yes	—
`description`	`string`	No	—
`stageId`	`string`	No	—
`tags`	`string[]`	No	—
`type`	`secret \| config`	No	—
`secretType`	`environment-arguments \| environment \| arguments`	No	—
`priority`	`number`	No	—
`restrictions`	`object`	No	—
`addonDependencies`	`object[]`	No	—
`externalAddonDependencies`	`object[]`	No	—
`secrets`	`object`	No	—

restrictions full type

{
  restricted?: boolean,
  nfObjects?: {
    id: string,
    type: service | job
  }[],
  tags?: string[],
  tagMatchCondition?: and | or,
  stageIds?: string[]
}

addonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

externalAddonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

secrets full type

{
  variables?: {
  },
  files?: {
  },
  dockerSecretMounts?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
  id: string,
  projectId?: string,
  name: string,
  description?: string,
  tags?: string[],
  type?: secret | config,
  secretType?: environment-arguments | environment | arguments,
  priority?: number,
  restrictions?: {
    restricted?: boolean,
    nfObjects?: {
      id: string,
      type: service | job
    }[],
    tags?: string[],
    tagMatchCondition?: and | or,
    stageIds?: string[]
  },
  secrets?: {
    variables?: {
    },
    files?: {
    },
    dockerSecretMounts?: {
    }
  },
  createdAt?: string,
  updatedAt?: string
}

update

secrets.update Update a secret group in a Northflank project Risk: write

await corsair.northflank.api.secrets.update({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`secretId`	`string`	Yes	—
`description`	`string`	No	—
`priority`	`number`	No	—
`restrictions`	`object`	No	—
`addonDependencies`	`object[]`	No	—
`externalAddonDependencies`	`object[]`	No	—
`type`	`secret \| config`	No	—
`secretType`	`environment-arguments \| environment \| arguments`	No	—
`secrets`	`object`	No	—

restrictions full type

{
  restricted?: boolean,
  nfObjects?: {
    id: string,
    type: service | job
  }[],
  tags?: string[],
  tagMatchCondition?: and | or,
  stageIds?: string[]
}

addonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

externalAddonDependencies full type

{
  addonId: string,
  keys?: {
    keyName: string,
    aliases?: string[]
  }[]
}[]

secrets full type

{
  variables?: {
  },
  files?: {
  },
  dockerSecretMounts?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	—

data full type

{
}

Services

list

services.list List services in a Northflank project Risk: read

await corsair.northflank.api.services.list({});

Input

Name	Type	Required	Description
`projectId`	`string`	Yes	—
`page`	`number`	No	—
`per_page`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	Yes	—
`pagination`	`object`	No	—

data full type

{
  services: {
    id: string,
    appId?: string,
    projectId?: string,
    stageId?: string,
    name?: string,
    description?: string,
    serviceType?: combined | build | deployment,
    disabledCI?: boolean,
    disabledCD?: boolean
  }[]
}

pagination full type

{
  hasNextPage: boolean,
  cursor?: string,
  count: number
}

Overview

Plugins

Addon Types

list

Cloud Providers

listNodeTypes

listRegions

Misc

getDnsId

Pipelines

list

Plans

list

Projects

create

createOrUpdate

delete

get

list

update

Regions

list

Secrets

create

createOrUpdate

get

getDetails

list

patch

update

Services

list

​Addon Types

​list

​Cloud Providers

​listNodeTypes

​listRegions

​Misc

​getDnsId

​Pipelines

​list

​Plans

​list

​Projects

​create

​createOrUpdate

​delete

​get

​list

​update

​Regions

​list

​Secrets

​create

​createOrUpdate

​get

​getDetails

​list

​patch

​update

​Services

​list

Addon Types

list

Cloud Providers

listNodeTypes

listRegions

Misc

getDnsId

Pipelines

list

Plans

list

Projects

create

createOrUpdate

delete

get

list

update

Regions

list

Secrets

create

createOrUpdate

get

getDetails

list

patch

update

Services

list