EzeroApimaticSDK 0.0.1

Getting Started with env zero API

Introduction

This document describes the resources that make up the official env zero REST API.

Base URL

https://api.env0.com

Content types

All requests should be in JSON format and include the accept: application/json header.

Authentication

HTTP Basic authentication. Send the API Key ID as the username and the API Key Secret as the password. Keys are created under Organization Settings → API Keys (Admin or User scope) or Personal Settings → API Keys (Personal scope).

Scope of this document

This specification covers the environment drift-governance surface of the env zero API and the environment, deployment, template, configuration and project endpoints that support it. It was reconstructed from the OpenAPI fragments published on https://docs.envzero.com and is a subset of the full API.

Error responses

401 and 403 responses return { "message": string } and are documented on every operation. The upstream documentation does not define response bodies for other non-2xx status codes, so none are asserted here.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package EzeroApimaticSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/EzeroApimaticSDK/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using EnvZeroApi.Standard;
using EnvZeroApi.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

EnvZeroApiClient client = new EnvZeroApiClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "BasicAuthUserName",
            "BasicAuthPassword"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using EnvZeroApi.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = EnvZeroApiClient
    .FromConfiguration(configuration.GetSection("EnvZeroApi"));

See the Configuration-Based Initialization section for details.

Authorization

This API uses the following authentication schemes.

• env0_API_Key (Basic Authentication)

List of APIs

• Bulk Operations
• Deployment Logs
• Approval Policy
• Environment Outputs
• Environments
• Drift
• Scheduling
• Templates
• Configuration
• Projects
• Organization
• Notifications
• Credentials

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter