Archive an environment

curl --request DELETE \
  --url https://mycluster.domino.tech/api/environments/v1/environments/{environmentId} \
  --header 'X-Domino-Api-Key: <api-key>'

import requests

url = "https://mycluster.domino.tech/api/environments/v1/environments/{environmentId}"

headers = {"X-Domino-Api-Key": "<api-key>"}

response = requests.delete(url, headers=headers)

print(response.text)

const options = {method: 'DELETE', headers: {'X-Domino-Api-Key': '<api-key>'}};

fetch('https://mycluster.domino.tech/api/environments/v1/environments/{environmentId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://mycluster.domino.tech/api/environments/v1/environments/{environmentId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "X-Domino-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://mycluster.domino.tech/api/environments/v1/environments/{environmentId}"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("X-Domino-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.delete("https://mycluster.domino.tech/api/environments/v1/environments/{environmentId}")
  .header("X-Domino-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mycluster.domino.tech/api/environments/v1/environments/{environmentId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["X-Domino-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "environment": {
    "archived": false,
    "id": "623132867a0af0281c01a69c",
    "name": "MyOrg",
    "rebuildOnBaseChanges": "never",
    "supportedClusters": [
      "dask"
    ],
    "visibility": "global",
    "activeRevisionTags": [
      "<string>"
    ],
    "internalTags": [
      "<string>"
    ],
    "isCurated": true,
    "latestRevision": {
      "availableTools": [
        {
          "name": "Jupyter",
          "startScripts": [
            "echo hello"
          ],
          "title": "Jupyter",
          "iconUrl": "/assets/images/workspace-logos/Jupyter.svg",
          "proxyConfig": {
            "internalPath": "/{{ownerUsername}}/{{projectName}}/{{sessionPathComponent}}/{{runId}}/{{#if pathToOpen}}tree/{{pathToOpen}}{{/if}}",
            "port": 8888,
            "requireSubdomain": false,
            "rewrite": false
          },
          "supportedFileExtensions": [
            ".ipynb"
          ]
        }
      ],
      "id": "62313cfd7a0af0281c01a6a6",
      "number": 4,
      "status": "queued"
    },
    "owner": {
      "id": "6231327c7a0af0281c01a69b",
      "ownerType": "individual",
      "username": "OrgOwner"
    },
    "restrictedRevision": {
      "availableTools": [
        {
          "name": "Jupyter",
          "startScripts": [
            "echo hello"
          ],
          "title": "Jupyter",
          "iconUrl": "/assets/images/workspace-logos/Jupyter.svg",
          "proxyConfig": {
            "internalPath": "/{{ownerUsername}}/{{projectName}}/{{sessionPathComponent}}/{{runId}}/{{#if pathToOpen}}tree/{{pathToOpen}}{{/if}}",
            "port": 8888,
            "requireSubdomain": false,
            "rewrite": false
          },
          "supportedFileExtensions": [
            ".ipynb"
          ]
        }
      ],
      "id": "62313cfd7a0af0281c01a6a6",
      "number": 4,
      "status": "queued"
    },
    "selectedRevision": {
      "availableTools": [
        {
          "name": "Jupyter",
          "startScripts": [
            "echo hello"
          ],
          "title": "Jupyter",
          "iconUrl": "/assets/images/workspace-logos/Jupyter.svg",
          "proxyConfig": {
            "internalPath": "/{{ownerUsername}}/{{projectName}}/{{sessionPathComponent}}/{{runId}}/{{#if pathToOpen}}tree/{{pathToOpen}}{{/if}}",
            "port": 8888,
            "requireSubdomain": false,
            "rewrite": false
          },
          "supportedFileExtensions": [
            ".ipynb"
          ]
        }
      ],
      "id": "62313cfd7a0af0281c01a6a6",
      "number": 4,
      "status": "queued"
    }
  },
  "metadata": {
    "notices": [
      "<string>"
    ],
    "requestId": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "code": "UNAUTHORIZED",
  "message": "Authentication is required to access this resource."
}

{
  "code": "FORBIDDEN",
  "message": "You do not have permission to perform this action."
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}