Connections > AWS Glue Schema Registry

APIs for managing connections that use the AWSGlueSchemaRegistry template.

DEPRECATED: This endpoint is deprecated and will be removed in a future version. Use provisioning APIs instead.

List available connections

get

Returns the list of available connections

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections
GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "name": "text",
    "lrn": "text",
    "templateName": "text",
    "templateVersion": 1,
    "tags": [
      "text"
    ],
    "deletable": true
  }
]

Add a new connection

post

Adds a new connection

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestringRequired

Name of the connection

Example: the-connection
tagsstring[]Optional
Responses
post
/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections
POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "name": "the-connection",
  "tags": [
    "text"
  ],
  "configurationObject": {
    "glueRegistryArn": "text",
    "glueRegistryCacheTtl": 1,
    "glueRegistryCacheSize": 1,
    "glueRegistryDefaultCompatibility": "BACKWARD"
  }
}
{
  "name": "the-connection"
}

Add a new connection V2

post

Adds a new connection V2

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestringRequired

Name of the connection

Example: the-connection
tagsstring[]Optional
Responses
post
/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections
POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 525

{
  "name": "the-connection",
  "tags": [
    "text"
  ],
  "configuration": {
    "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
    "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "sessionToken": "AQoDYXdzEJr...<remainder of token>",
    "authMode": "AWS-connection-1",
    "assumeRoleArn": "arn:aws:glue:eu-west-1:ACCOUNT_A_ID:schema-registry/GlueSRDemo",
    "assumeRoleSessionName": "GlueSchemaAccess",
    "glueRegistryArn": {
      "value": "text"
    },
    "glueRegistryCacheTtl": {
      "value": 1
    },
    "glueRegistryCacheSize": {
      "value": 1
    },
    "glueRegistryDefaultCompatibility": {
      "value": "BACKWARD"
    }
  }
}
{
  "name": "the-connection"
}

Validate a connection

post

Validates the connection

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestringRequired

Name of the connection

Example: the-connection
updatebooleanOptional

true if testing an update to an existing connection, false if testing a new connection

Responses
200Success

No content

post
/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/test
POST /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "name": "the-connection",
  "configurationObject": {
    "glueRegistryArn": "text",
    "glueRegistryCacheTtl": 1,
    "glueRegistryCacheSize": 1,
    "glueRegistryDefaultCompatibility": "BACKWARD"
  },
  "update": true
}

No content

Validate a connection V2

post

Validates the connection V2

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestringRequired

Name of the connection

Example: the-connection
updatebooleanOptional

true if testing an update to an existing connection, false if testing a new connection

Responses
200Success

No content

post
/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections/test
POST /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections/test HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 523

{
  "name": "the-connection",
  "configuration": {
    "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
    "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "sessionToken": "AQoDYXdzEJr...<remainder of token>",
    "authMode": "AWS-connection-1",
    "assumeRoleArn": "arn:aws:glue:eu-west-1:ACCOUNT_A_ID:schema-registry/GlueSRDemo",
    "assumeRoleSessionName": "GlueSchemaAccess",
    "glueRegistryArn": {
      "value": "text"
    },
    "glueRegistryCacheTtl": {
      "value": 1
    },
    "glueRegistryCacheSize": {
      "value": 1
    },
    "glueRegistryDefaultCompatibility": {
      "value": "BACKWARD"
    }
  },
  "update": true
}

No content

Get connection details

get

Returns the connection details

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
namestringRequired

The name of the connection

Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name}
GET /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "name": "the-connection",
  "lrn": "text",
  "templateVersion": 1,
  "templateName": "Kafka",
  "builtIn": true,
  "createdBy": "text",
  "createdAt": 1,
  "modifiedBy": "text",
  "modifiedAt": 1,
  "configurationObject": {
    "glueRegistryArn": "text",
    "glueRegistryCacheTtl": 1,
    "glueRegistryCacheSize": 1,
    "glueRegistryDefaultCompatibility": "BACKWARD"
  },
  "tags": [
    "text"
  ],
  "deletable": true
}

Update connection details

put

Updates the connection details

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
namestringRequired

The name of the connection

Body
tagsstring[]Optional
Responses
200Success
application/json
put
/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name}
PUT /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "tags": [
    "text"
  ],
  "configurationObject": {
    "glueRegistryArn": "text",
    "glueRegistryCacheTtl": 1,
    "glueRegistryCacheSize": 1,
    "glueRegistryDefaultCompatibility": "BACKWARD"
  }
}
{
  "name": "the-connection"
}

Delete a connection

delete

Deletes the connection

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
namestringRequired

The name of the connection

Responses
200Success

No content

delete
/api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name}
DELETE /api/v1/environments/{environment}/proxy/api/v1/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update connection details V2

put

Updates the connection details V2

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
namestringRequired

The name of the connection

Body
tagsstring[]Optional
Responses
200Success
application/json
put
/api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name}
PUT /api/v1/environments/{environment}/proxy/api/v2/connection/connection-templates/AWSGlueSchemaRegistry/connections/{name} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 501

{
  "tags": [
    "text"
  ],
  "configuration": {
    "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
    "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
    "sessionToken": "AQoDYXdzEJr...<remainder of token>",
    "authMode": "AWS-connection-1",
    "assumeRoleArn": "arn:aws:glue:eu-west-1:ACCOUNT_A_ID:schema-registry/GlueSRDemo",
    "assumeRoleSessionName": "GlueSchemaAccess",
    "glueRegistryArn": {
      "value": "text"
    },
    "glueRegistryCacheTtl": {
      "value": 1
    },
    "glueRegistryCacheSize": {
      "value": 1
    },
    "glueRegistryDefaultCompatibility": {
      "value": "BACKWARD"
    }
  }
}
{
  "name": "the-connection"
}

Last updated

Was this helpful?