HTTP API reference › Gala Launchpad › token-bans
Gala Launchpad — token-bans
8 operations in this group.
- GET /v1/token-bans — List banned tokens
- POST /v1/token-bans — Ban a token
- GET /v1/token-bans/{tokenName} — Get token ban
- DELETE /v1/token-bans/{tokenName} — Unban a token
- GET /v1/tokens/{tokenName}/bans — List users banned from token
- POST /v1/tokens/{tokenName}/bans — Ban user from token
- GET /v1/tokens/{tokenName}/bans/{userAddress} — Check if user is banned from token
- DELETE /v1/tokens/{tokenName}/bans/{userAddress} — Unban user from token
GET /v1/token-bans
TokenBanController_listBans
List banned tokens
List all banned tokens (admin/overseer only)
Authentication: apiKeyAuth, bearer
api key auth
Responses
200 — Cursor-paginated token bans with pool metadata.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto & object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
| data | TokenBanListResponseDto | yes |
401 — Unauthorized - missing or invalid JWT token or admin API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden - user is not admin or overseer
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
500 — Internal server error - database query failed
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for authorization and token ban listing failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]
POST /v1/token-bans
TokenBanController_createBan
Ban a token
Ban a token from the platform (admin/overseer only)
Authentication: apiKeyAuth, bearer
api key auth
Request body
Required: yes
application/json
Schema: CreateTokenBanDto
| Field | Type | Required | Description |
|---|---|---|---|
| reason | string | no | Optional reason for the ban. |
| tokenName | string | yes | Token name to ban. |
Responses
200 — Created token ban with associated pool metadata.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto & object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
| data | TokenBanResponseDto | yes |
400 — Bad request - tokenName missing or reason exceeds max length
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
401 — Unauthorized - missing or invalid JWT token or admin API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden - user is not admin or overseer
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
404 — Token not found - tokenName does not match any existing pool
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
500 — Internal server error - failed to create ban in database
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for authorization and token ban failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example request
[]
Example response
[]
GET /v1/token-bans/{tokenName}
TokenBanController_getBan
Get token ban
Get ban details for a specific token
Authentication: apiKeyAuth, bearer
token name api key auth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | string | Token name resolved to a platform pool. |
Responses
200 — Token ban details, or null when no ban exists.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto & object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
| data | oneOf: TokenBanResponseDto | object nullable enum: | yes |
401 — Unauthorized - missing or invalid JWT token or admin API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden - user is not admin or overseer
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
404 — Token not found - tokenName does not match any existing pool or ban not found
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
500 — Internal server error - database query failed
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for authorization and token ban lookup failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]
DELETE /v1/token-bans/{tokenName}
TokenBanController_removeBan
Unban a token
Remove a ban from a token (admin/overseer only)
Authentication: apiKeyAuth, bearer
token name api key auth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | string | Token name resolved to a platform pool. |
Responses
200 — Ban removed; the global success envelope omits data.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
401 — Unauthorized - missing or invalid JWT token or admin API key
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden - user is not admin or overseer
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
404 — Token not found - tokenName does not match any existing pool
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
500 — Internal server error - failed to remove ban from database
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for authorization and token unban failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]
GET /v1/tokens/{tokenName}/bans
TokenBansController_listBans
List users banned from token
List users banned from token
Authentication: apiKeyAuth, bearer
token name api key auth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | string | Token name whose bans are listed. |
Responses
200 — Cursor-paginated user bans for the token.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto & object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
| data | BanListResponseDto | yes |
401 — Unauthorized
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
404 — Token not found
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for token ban listing failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]
POST /v1/tokens/{tokenName}/bans
TokenBansController_banUser
Ban user from token
Ban user from token
Authentication: apiKeyAuth, bearer
token name api key auth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | string | Token name whose user is banned. |
Request body
Required: yes
application/json
Schema: CreateBanDto
| Field | Type | Required | Description |
|---|---|---|---|
| durationSeconds | number | no | |
| reason | string | no | |
| userAddress | string (gala-chain-address) | yes |
Responses
201 — Created ban record.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto & object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
| data | BanResponseDto | yes |
400 — Invalid user address
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
401 — Unauthorized
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
404 — Token not found
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for token ban creation failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example request
[]
Example response
[]
GET /v1/tokens/{tokenName}/bans/{userAddress}
TokenBansController_getBanStatus
Check if user is banned from token
Check if user is banned from token
token name user address
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | string | Token name to check. |
| userAddress | path | required | string | Wallet address to check. |
Responses
200 — Ban details, or null when the user is not banned.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto & object
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
| data | oneOf: BanResponseDto | object nullable enum: | yes |
404 — Token not found
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for token ban lookup failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]
DELETE /v1/tokens/{tokenName}/bans/{userAddress}
TokenBansController_unbanUser
Unban user from token
Unban user from token
Authentication: apiKeyAuth, bearer
token name user address api key auth
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| tokenName | path | required | string | Token name whose user is unbanned. |
| userAddress | path | required | string | Wallet address to unban. |
Responses
200 — User unbanned; the success envelope omits data.
Content type: application/json
Schema: ApiSuccessEnvelopeMetadataDto
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: false | yes | Successful response marker. |
| message | string | yes | Response message. |
| status | number | yes | HTTP status code. |
401 — Unauthorized
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
403 — Forbidden
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
404 — Token or ban not found
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
default — Shared error envelope for token unban failures.
Content type: application/json
Schema: ApiErrorEnvelope
| Field | Type | Required | Description |
|---|---|---|---|
| error | boolean enum: true | yes | |
| message | oneOf: string | array<string> | yes | |
| status | integer | yes | HTTP status code. |
| message | string | yes | |
| statusCode | integer | yes | HTTP status code. |
Example response
[]