Validate a Registries' credentials

POST /v2/registries/{registryId}/actions/validate-credentials/

API version

v2

Request method

POST

Operation ID

container-validate-registry-credentials

---

Request

• registryIdstring (uuid)

  required

  ID if the Registry to validate the credentials for.

Responses

Format

application/json

Description

OK

Schema documentation

• validboolean

  required

Example

{
  "valid": true
}

JSON Schema

{
  "properties": {
    "valid": {
      "type": "boolean"
    }
  },
  "required": [
    "valid"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/registries/f0f86186-0a5a-45b2-aa33-502777496347/actions/validate-credentials

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.container.validateRegistryCredentials({
  "registryId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Container\ValidateRegistryCredentials\ValidateRegistryCredentialsRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new ValidateRegistryCredentialsRequest(
  registryId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->container()->validateRegistryCredentials($request);

var_dump($response->getBody();