GZCTF Server API

https://gzctf.apidocumentation.com/api-reference
Admin
The GZCTF Server API provides a comprehensive set of endpoints for managing user accounts, game...
Tokens:1,041
Snippets:7
Trust Score:6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Ruby Client Library Example

Source: https://gzctf.apidocumentation.com/api-reference/index

Example code for interacting with the API using the Ruby client library. This snippet assumes the library is installed and configured.

```ruby
# Ruby client library example
# Assumes installation and configuration of the client library

# Example usage:
# response = MyApiClient.some_method(param1: 'value1', param2: 123)
# puts response.body
```

--------------------------------

### Python Client Library Example

Source: https://gzctf.apidocumentation.com/api-reference/index

Example code for interacting with the API using the Python client library. This snippet assumes the library is installed and configured.

```python
# Python client library example
# Assumes installation and configuration of the client library

# Example usage:
# import my_api_client
# 
# client = my_api_client.MyApiClient()
# response = client.some_method(param1='value1', param2=123)
# print(response.body)
```

--------------------------------

### PHP Client Library Example

Source: https://gzctf.apidocumentation.com/api-reference/index

Example code for interacting with the API using the PHP client library. This snippet assumes the library is installed and configured.

```php
// PHP client library example
// Assumes installation and configuration of the client library

// Example usage:
// $client = new MyApiClient();
// $response = $client->someMethod(['param1' => 'value1', 'param2' => 123]);
// echo $response->getBody();
```

--------------------------------

### Node.js Client Library Example

Source: https://gzctf.apidocumentation.com/api-reference/index

Example code for interacting with the API using the Node.js client library. This snippet assumes the library is installed and configured.

```javascript
// Node.js client library example
// Assumes installation and configuration of the client library

// Example usage:
// const client = require('my-api-client');
// client.someMethod({ param1: 'value1', param2: 123 })
//   .then(response => {
//     console.log(response.body);
//   })
//   .catch(error => {
//     console.error(error);
//   });
```

--------------------------------

### Asset Management API

Source: https://gzctf.apidocumentation.com/api-reference/index

Endpoints for managing platform assets, including uploads, downloads, and deletions.

```APIDOC
## Assets Endpoints

### Description
Provides access to asset management operations.

### Method
PUT

### Endpoint
/assets/{assetId}

### Parameters
#### Path Parameters
- **assetId** (string) - Required - The unique identifier of the asset to update.

#### Request Body
- **fileName** (string) - Optional - The new name for the asset file.
- **description** (string) - Optional - A new description for the asset.

### Request Example
```json
{
  "fileName": "updated_report.pdf",
  "description": "Updated quarterly report."
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating successful asset update.
- **assetId** (string) - The ID of the updated asset.

#### Response Example
```json
{
  "message": "Asset updated successfully",
  "assetId": "asset789"
}
```
```

--------------------------------

### Account Management API

Source: https://gzctf.apidocumentation.com/api-reference/index

Endpoints for managing user accounts, including registration, login, and profile updates.

```APIDOC
## Account Endpoints

### Description
Provides access to account-related operations.

### Method
GET

### Endpoint
/account

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user account.

### Request Example
```json
{
  "userId": "user123"
}
```

### Response
#### Success Response (200)
- **accountId** (string) - The unique identifier for the account.
- **username** (string) - The username of the account.
- **email** (string) - The email address associated with the account.

#### Response Example
```json
{
  "accountId": "acc987",
  "username": "example_user",
  "email": "user@example.com"
}
```
```

--------------------------------

### Admin Operations API

Source: https://gzctf.apidocumentation.com/api-reference/index

Endpoints for administrative tasks, such as managing users, roles, and system settings.

```APIDOC
## Admin Endpoints

### Description
Provides access to administrative functions.

### Method
POST

### Endpoint
/admin/users

### Parameters
#### Request Body
- **username** (string) - Required - The username for the new user.
- **role** (string) - Optional - The role to assign to the new user (e.g., 'admin', 'user').

### Request Example
```json
{
  "username": "new_admin",
  "role": "admin"
}
```

### Response
#### Success Response (201)
- **message** (string) - Confirmation message indicating successful user creation.
- **userId** (string) - The ID of the newly created user.

#### Response Example
```json
{
  "message": "User created successfully",
  "userId": "usr456"
}
```
```
Tokens:
Raw