README

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

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "ezero-apimatic/ezero-apimatic-sdk:0.0.1"

Or add it to the composer.json file manually as given below:

"require": {
    "ezero-apimatic/ezero-apimatic-sdk": "0.0.1"
}

You can also view the package at: https://packagist.org/packages/ezero-apimatic/ezero-apimatic-sdk#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:

use EnvZeroApiLib\Logging\LoggingConfigurationBuilder;
use EnvZeroApiLib\Logging\RequestLoggingConfigurationBuilder;
use EnvZeroApiLib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use EnvZeroApiLib\Authentication\BasicAuthCredentialsBuilder;
use EnvZeroApiLib\EnvZeroApiClientBuilder;

$client = EnvZeroApiClientBuilder::init()
    ->basicAuthCredentials(
        BasicAuthCredentialsBuilder::init(
            'BasicAuthUserName',
            'BasicAuthPassword'
        )
    )
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

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

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse