Retrieve

API Reference

Projects

Configs

Retrieve configuration files for a project

client.projects.configs.retrieve(ConfigRetrieveParamsparams?, RequestOptionsoptions?): contentstringConfigRetrieveResponse

get/v0/projects/{project}/configs

Retrieve configuration files for a project

Parameters

paramsprojectstringbranchstringincludestringConfigRetrieveParams

Hide ParametersShow Parameters

projectstring

optional

Path param:

branchstring

optional

Query param: Branch name, defaults to "main"

includestring

optional

Query param:

Returns

ConfigRetrieveResponsealias

Record<string, item>

Config files contents

Hide ParametersShow Parameters

contentstring

The file content

HTTPTypeScriptPythonGo

import Stainless from '@stainless-api/sdk';

const client = new Stainless({
  apiKey: 'My API Key',
});

const config = await client.projects.configs.retrieve({ project: 'project' });

console.log(config);

200 Example

{
  "foo": {
    "content": "content"
  }
}