@octopusdeploy/api-client

:octopus: TypeScript API Client for Octopus Deploy

🚀 Getting Started

The TypeScript API Client for Octopus Deploy is easy to use after it's been initialized. Refer to Getting Started for step-by-step set of instructions on setup, initialization, and usage of its functionality.

Documentation

The reference documentation for this library is auto-generated via Typedoc and made available through GitHub Pages: octopusdeploy.github.io/api-client.ts

🏎 Usage

import { Client, ClientConfiguration, Repository } from "@octopusdeploy/api-client";
import type { ProjectResource } from "@octopusdeploy/message-contracts";

// explicit configuration
//
// const configuration: ClientConfiguration = {
//     agent: new Agent({ proxy: { hostname: '127.0.0.1', port: 8866 } }), // proxy agent if required
//     apiKey: "api-key",
//     apiUri: "api-uri",
//     space: "space-id",
// };
//
// const client = await Client.create(configuration);

// environment variables
//
// OCTOPUS_API_KEY: the API key used to connect to an instance of Octopus Deploy
// OCTOPUS_HOST: the host instance of Octopus Deploy
// OCTOPUS_SPACE: the space to target API commands in Octopus Deploy

// assume conventional configuration via environment variables
const client = await Client.create();
if (client === undefined) {
    throw new Error("client could not be constructed");
}

const repository = new Repository(client);
const projectNameOrId: string = "project-name-or-ID";

console.log(`Getting project, "${projectNameOrId}"...`);

let project: ProjectResource | undefined;
try {
    project = await repository.projects.find(projectNameOrId);
} catch (error) {
    console.error(error);
}

if (project !== null && project !== undefined) {
    console.log(`Project found: "${project?.Name}" (${project?.Id})`);
} else {
    console.error(`Project, "${projectNameOrId}" not found`);
}

Changelog

1.3.2 (2022-07-19)

Bug Fixes

• update how we import fs.promises (9eaf40e)