List containers

GET https://www.digicert.com/services/v2/container

Use this endpoint to list all containers in your account.

Example requests and responses

Example 1. cURL

curl -X GET \
  https://www.digicert.com/services/v2/container \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}'

Example 2. Python

import requests

url = "https://www.digicert.com/services/v2/container"

payload = ""
headers = {
    'X-DC-DEVKEY': "{{api_key}}",
    'Content-Type': "application/json"
    }

response = requests.request("GET", url, data=payload, headers=headers)

print(response.text)

Example 3. Go

package main

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

func main() {

	url := "https://www.digicert.com/services/v2/container"

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

	req.Header.Add("X-DC-DEVKEY", "{{api_key}}")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}

Example 4. NodeJS

var request = require("request");

var options = { method: 'GET',
  url: 'https://www.digicert.com/services/v2/container',
  headers: 
   { 'Content-Type': 'application/json',
     'X-DC-DEVKEY': '{{api_key}}' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

Example 5. 200 OK

{
  "containers": [
    {
      "id": 3,
      "public_id": "<public_id>",
      "name": "Company Name, Inc.",
      "parent_id": 0,
      "template_id": 5,
      "ekey": "<ekey>",
      "has_logo": true,
      "is_active": true,
      "allowed_domain_names": [
        "example.com"
      ]
    },
    {
      "id": 11224,
      "public_id": "<public_id>",
      "name": "History department",
      "description": "For the history department.",
      "parent_id": 3,
      "template_id": 6,
      "ekey": "<ekey>",
      "has_logo": false,
      "is_active": true,
      "allowed_domain_names": [
        "example1.com"
      ],
      "organization_assignments": [
        {
          "id": 7,
          "status": "active",
          "name": "Organization Name, LLC",
          "display_name": "Organization Name",
          "is_active": "1"
        }
      ]
    },
    {
      "id": 11225,
      "public_id": "<public_id>",
      "name": "IT department",
      "description": "For the IT department.",
      "parent_id": 3,
      "template_id": 6,
      "ekey": "<ekey>",
      "has_logo": false,
      "is_active": true,
      "user_id_assignments": [
        "123456"
      ],
      "allowed_domain_names": [
        "example2.com",
        "example3.com"
      ]
    }
  ]
}

Response parameters

Name	Type	Description
containers	array	List of all containers.
.. id	int	Container ID.
.. public_id	string	Public ID of the container.
.. name	string	Name of the container.
.. description	string	Description for the container.
.. parent_id	int	ID of the container's parent.
.. template_id	int	Template ID of the container.
.. has_logo	bool	Custom logo status of the container.
.. is_active	bool	Active status of the container.
.. user_id_assignments	array	List of users that are assigned to the container.
.. allowed_domain_names	array	List of domains that can be used with the container.
.. organization_assignments	array	List of organization objects that are assigned to the container.

In this section: