Flag
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents a single flag assigned to the application. For a specific flag available in the system, see Flag (global).
/api/v9/applications/ID/flags/IDGET Get a flag
A request with the GET verb returns some additional information about the flag association (date assigned etc.). Use the HEAD verb to test if the application in question has this flag.
This request does not return the flag itself, but rather represents the relationships between the application and the flag. Follow the flag URI in the response to retrieve further information about the flag in question.
GET /api/v9/applications/123/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applications/123/flags/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1456 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The flag was successfully assigned |
404 Not Found | The flag does not exist |
404 Not Found | The flag was not assigned to this application |
Example response
{
"assigned": "2025-12-09T13:26:29+00:00",
"flag": "/api/v9/applications/flags/2"
}PUT Assign a flag
Assign a flag (identified by its ID) to the application in question.
This request requires that the flag already exists. Use POST /api/v9/applications/flags to create a flag first, then this API request will allow you to set the flag (identified by its code) to any number of applications.
In other words, this will not create a new flag, but create a relationship (association) between an existing flag and an application.
PUT /api/v9/applications/123/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applications/123/flags/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The flag was successfully assigned |
404 Not Found | The flag does not exist |
DELETE Delete a flag
Remove the flag (identified by its ID) from the application in question.
This request does not delete the flag itself. It only removes its association with the application in question.
DELETE /api/v9/applications/123/flags/1
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
curl \
-X DELETE \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applications/123/flags/1"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
204 No Content | The flag was successfully deleted |
404 Not Found | The flag does not exist |
404 Not Found | The flag was not set to this application |