New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More

@octopusdeploy/api-client

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@octopusdeploy/api-client

TypeScript API client for Octopus Deploy


Version published
Maintainers
4
Created

:octopus: TypeScript API Client for Octopus Deploy

npm CI

🚀 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`);
}

FAQs

Package last updated on 21 Jul 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts