@octopusdeploy/api-client

:octopus: TypeScript API Client for Octopus Deploy

This repository contains the source code for the TypeScript API Client for Octopus Deploy.

❗️ Please note that the TypeScript API Client for Octopus Deploy currently assumes Node.js for the host runtime. Installation packages for Node.js can be found on Downloads.

🚀 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';

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);
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.1.5 (2021-12-01)

Features

• added documentation (9462cb8)
• apiClient: browser support (1ae4004)

Miscellaneous Chores

• release 1.1.5 (ab538c0)