GlueOps/autoglue

Fork 0

mirror of https://github.com/GlueOps/autoglue.git synced 2026-02-13 12:50:05 +01:00

Files

allanice001 e313d5fc4f fix: rename sdk to match repo & introduce git subtree

2025-11-02 22:30:34 +00:00

12 KiB

Raw Blame History

ServersApi

All URIs are relative to http://localhost:8080/api/v1

Method	HTTP request	Description
createServer	POST /servers	Create server (org scoped)
deleteServer	DELETE /servers/{id}	Delete server (org scoped)
getServer	GET /servers/{id}	Get server by ID (org scoped)
listServers	GET /servers	List servers (org scoped)
updateServer	PATCH /servers/{id}	Update server (org scoped)

createServer

DtoServerResponse createServer(body, xOrgID)

Create server (org scoped)

Creates a server bound to the org in X-Org-ID. Validates that ssh_key_id belongs to the org.

Example

import {
  Configuration,
  ServersApi,
} from '@glueops/autoglue-sdk-go';
import type { CreateServerRequest } from '@glueops/autoglue-sdk-go';

async function example() {
  console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: OrgKeyAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: OrgSecretAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: BearerAuth
    apiKey: "YOUR API KEY",
  });
  const api = new ServersApi(config);

  const body = {
    // DtoCreateServerRequest | Server payload
    body: ...,
    // string | Organization UUID (optional)
    xOrgID: xOrgID_example,
  } satisfies CreateServerRequest;

  try {
    const data = await api.createServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name	Type	Description	Notes
body	DtoCreateServerRequest	Server payload
xOrgID	`string`	Organization UUID	[Optional] [Defaults to `undefined`]

Return type

DtoServerResponse

Authorization

OrgKeyAuth, OrgSecretAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Created	-
400	invalid json / missing fields / invalid status / invalid ssh_key_id	-
401	Unauthorized	-
403	organization required	-
500	create failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteServer

string deleteServer(id, xOrgID)

Delete server (org scoped)

Permanently deletes the server.

Example

import {
  Configuration,
  ServersApi,
} from '@glueops/autoglue-sdk-go';
import type { DeleteServerRequest } from '@glueops/autoglue-sdk-go';

async function example() {
  console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: OrgKeyAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: OrgSecretAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: BearerAuth
    apiKey: "YOUR API KEY",
  });
  const api = new ServersApi(config);

  const body = {
    // string | Server ID (UUID)
    id: id_example,
    // string | Organization UUID (optional)
    xOrgID: xOrgID_example,
  } satisfies DeleteServerRequest;

  try {
    const data = await api.deleteServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name	Type	Description	Notes
id	`string`	Server ID (UUID)	[Defaults to `undefined`]
xOrgID	`string`	Organization UUID	[Optional] [Defaults to `undefined`]

Return type

string

Authorization

OrgKeyAuth, OrgSecretAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	No Content	-
400	invalid id	-
401	Unauthorized	-
403	organization required	-
500	delete failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getServer

DtoServerResponse getServer(id, xOrgID)

Get server by ID (org scoped)

Returns one server in the given organization.

Example

import {
  Configuration,
  ServersApi,
} from '@glueops/autoglue-sdk-go';
import type { GetServerRequest } from '@glueops/autoglue-sdk-go';

async function example() {
  console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: OrgKeyAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: OrgSecretAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: BearerAuth
    apiKey: "YOUR API KEY",
  });
  const api = new ServersApi(config);

  const body = {
    // string | Server ID (UUID)
    id: id_example,
    // string | Organization UUID (optional)
    xOrgID: xOrgID_example,
  } satisfies GetServerRequest;

  try {
    const data = await api.getServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name	Type	Description	Notes
id	`string`	Server ID (UUID)	[Defaults to `undefined`]
xOrgID	`string`	Organization UUID	[Optional] [Defaults to `undefined`]

Return type

DtoServerResponse

Authorization

OrgKeyAuth, OrgSecretAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	invalid id	-
401	Unauthorized	-
403	organization required	-
404	not found	-
500	fetch failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listServers

Array<DtoServerResponse> listServers(xOrgID, status, role)

List servers (org scoped)

Returns servers for the organization in X-Org-ID. Optional filters: status, role.

Example

import {
  Configuration,
  ServersApi,
} from '@glueops/autoglue-sdk-go';
import type { ListServersRequest } from '@glueops/autoglue-sdk-go';

async function example() {
  console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: OrgKeyAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: OrgSecretAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: BearerAuth
    apiKey: "YOUR API KEY",
  });
  const api = new ServersApi(config);

  const body = {
    // string | Organization UUID (optional)
    xOrgID: xOrgID_example,
    // string | Filter by status (pending|provisioning|ready|failed) (optional)
    status: status_example,
    // string | Filter by role (optional)
    role: role_example,
  } satisfies ListServersRequest;

  try {
    const data = await api.listServers(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name	Type	Description	Notes
xOrgID	`string`	Organization UUID	[Optional] [Defaults to `undefined`]
status	`string`	Filter by status (pending	provisioning
role	`string`	Filter by role	[Optional] [Defaults to `undefined`]

Return type

Array<DtoServerResponse>

Authorization

OrgKeyAuth, OrgSecretAuth, BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	organization required	-
500	failed to list servers	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateServer

DtoServerResponse updateServer(id, body, xOrgID)

Update server (org scoped)

Partially update fields; changing ssh_key_id validates ownership.

Example

import {
  Configuration,
  ServersApi,
} from '@glueops/autoglue-sdk-go';
import type { UpdateServerRequest } from '@glueops/autoglue-sdk-go';

async function example() {
  console.log("🚀 Testing @glueops/autoglue-sdk-go SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: OrgKeyAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: OrgSecretAuth
    apiKey: "YOUR API KEY",
    // To configure API key authorization: BearerAuth
    apiKey: "YOUR API KEY",
  });
  const api = new ServersApi(config);

  const body = {
    // string | Server ID (UUID)
    id: id_example,
    // DtoUpdateServerRequest | Fields to update
    body: ...,
    // string | Organization UUID (optional)
    xOrgID: xOrgID_example,
  } satisfies UpdateServerRequest;

  try {
    const data = await api.updateServer(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Parameters

Name	Type	Description	Notes
id	`string`	Server ID (UUID)	[Defaults to `undefined`]
body	DtoUpdateServerRequest	Fields to update
xOrgID	`string`	Organization UUID	[Optional] [Defaults to `undefined`]

Return type

DtoServerResponse

Authorization

OrgKeyAuth, OrgSecretAuth, BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
400	invalid id / invalid json / invalid status / invalid ssh_key_id	-
401	Unauthorized	-
403	organization required	-
404	not found	-
500	update failed	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

12 KiB Raw Blame History

ServersApi

createServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

deleteServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listServers

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

updateServer

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

12 KiB

Raw Blame History