NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Unique ID for the namespace. |
|
| ID of the user who owns the namespace. |
|
| ID of the top-level namespace for the current namespace. This will match the |
|
| ID of the namespace's parent, if any. |
|
| The name of the current namespace. |
|
| The fulle path of the namespace, this will include the parent namespace names. |
|
| The description of the current namespace. |
|
| The visibility level of the namespace, will be one of:
|
|
| The RFC3339 formatted string at which the namespace was created. |
|
| The API URL to the namespace entity itself. |
|
| The API URL to the namespace's builds. |
|
| The API URL to the namespace's children. |
|
| The API URL to the namespace's images. |
|
| The API URL to the namespace's objects. |
|
| The API URL to the namespace's variables. |
|
| The API URl to the namespace's keys. |
|
| The API URL to the namespace's collaborators. |
|
| The API URL to the namespace's webhooks. |
|
| The user of the namespace. |
|
| The parent of the namespace, if any. |
|
| The build that was most recently submitted to the namespace, if any. |
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Unique ID for the webhook. |
|
| ID of the user who authored the webhook. |
|
| ID of the user who owns the webhook. |
|
| ID of the namespace the webhook belongs to. |
|
| URL to send the event payload to. |
|
| Whether or not the event will be sent over TLS. |
|
| The events the webhook will activate on. See the Event payloads section for details on the different webhook events. |
|
| The namespace of the webhook. |
|
| The last response received from the webhook, if any. |
|
| The HTTP status code of the delivery |
|
| The duration of the request delivered to the URL in nanoseconds. |
|
| The error that occurred if the event failed to be delivered. This will be |
|
| The RFC3339 formatted string at which the delivery was made. |
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Unique ID for the user. |
|
| The email of the user. |
|
| The username of the user. |
|
| The RFC3339 formatted string for when the user created their account. |
|
| The API URL to the collaborator entity itself. |
GET
/namespaces
POST
/namespaces
GET
/n/:username/:path
GET
/n/:username/:path/-/badge.svg
GET
/n/:username/:path/-/builds
GET
/n/:username/:path/-/namespaces
GET
/n/:username/:path/-/images
GET
/n/:username/:path/-/objects
GET
/n/:username/:path/-/variables
GET
/n/:username/:path/-/keys
GET
/n/:username/:path/-/invites
GET
/n/:username/:path/-/collaborators
GET
/n/:username/:path/-/webhooks
POST
/n/:username/:path/-/webhooks
PATCH
/n/:username/:path/-/webhooks/:id
DELETE
/n/:username/:path/-/webhooks/:id
PATCH
/n/:username/:path
DELETE
/n/:username/:path
List the namespaces for the currently authenticated user. The following parameters can be given as query parameters to the URL. This requires the namespace:read
permission for the user.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the namespaces with paths like the given value. |
This will return a list of namespaces. The list will be paginated to 25 namespaces per page, and will be ordered lexically. If the namespaces were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/namespaces?page=1>; rel="prev",
<https://api.djinn-ci.com/namespaces?page=3>; rel="next"
This will create a new namespace for the currently authenticated user. This requires the namespace:write
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| No | The name of the parent namespace to create the new namespace under. |
|
| Yes | The name of the new namespace. |
|
| No | The deescription of the namespace. |
|
| No | The visibility level of the namespace, will be one of:
This will default to |
This will return an SVG badge of the namespace by the given :username
, with the given :path
. This SVG will show the status of the most recently submitted build to the namespace. This requires no permission for the user.
This will return one of the following SVG badges.
BADGE | DESCRIPTION |
---|---|
No build has been submitted to the namespace, or the namespace is set to | |
The build is queued. | |
The build is running. | |
The build passed. | |
The build bassed but encountered failures. | |
The build failed. | |
The build was killed. | |
The build timed out. |
List the builds for the given namespace. The following parameters can be given as query parameters to the URL. This requires the namespace:read
permission for the user.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| No | Get the builds with the given tag name. |
|
| No | Get the builds with tags like the given value. |
|
| No | Get the builds with the given status, will be one of:
|
This will return a list of builds. The list will be paginated to 25 builds per page, and will be ordered by the most recently submitted builds first. If the builds were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/n/me/djinn/-/builds?page=1>; rel="prev",
<https://api.djinn-ci.com/n/me/djinn/-/builds?page=3>; rel="next"
This will get the child namespaces in the given namespace. This requires the namespace:read
permission.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the namespaces with paths like the given value. |
This will return a list of namespaces. The list will be paginated to 25 namespaces per page, and will be ordered lexically. If the namespaces were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/n/me/djinn/-/namespaces?page=1>; rel="prev",
<https://api.djinn-ci.com/n/me/djinn/-/namespaces?page=3>; rel="next"
List the images for the given namespace. The following parameters can be given as query parameters to the URL. This requires the namespace:read
permission for the user.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the images with names like the given value. |
This will return a list of images. The list will be paginated to 25 images per page, and will be ordered by the most recently created images first. If the images were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/n/me/djinn/-/images?page=1>; rel="prev",
<https://api.djinn-ci.com/n/me/djinn/-/images?page=3>; rel="next"
List the objects for the given namespace. The following parameters can be given as query parameters to the URL. This requires the namespace:read
permission for the user.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the objects with names like the given value. |
This will return a list of objects. The list will be paginated to 25 objects per page, and will be ordered lexically. If the objects were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/n/me/djinn/-/objects?page=1>; rel="prev",
<https://api.djinn-ci.com/n/me/djinn/-/objects?page=3>; rel="next"
List the variables for the given namespace. The following parameters can be given as query parameters to the URL. This requires the namespace:read
permission for the user.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the variables with names like the given value. |
This will return a list of variable. The list will be paginated to 25 variables per page, and will be ordered lexically. If the crons were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/n/me/djinn/-/variables?page=1>; rel="prev",
<https://api.djinn-ci.com/n/me/djinn/-/variables?page=3>; rel="next"
List the keys for the given namespace. The following parameters can be given as query parameters to the URL. This requires the namespace:read
permission for the user.
NAME | TYPE | DESCRIPTION |
---|---|---|
|
| Get the keys with names like the given value. |
This will return a list of keys. The list will be paginated to 25 keys per page, and will be ordered lexically. If the crons were paginated, then the pagination information will be in the response header Link
.
Link: <https://api.djinn-ci.com/n/me/djinn/-/keys?page=1>; rel="prev",
<https://api.djinn-ci.com/n/me/djinn/-/keys?page=3>; rel="next"
List the collaborators for the given namespace. This requires the namespace:read
permission for the user.
This will return a list of collaborators.
This will create a webhook for the given namespace. This requires the namespace:write
permission for the user.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| Yes | The URL to send the event payload to. |
|
| No | The secret to sign the event payload with. |
|
| No | Whether or not to use TLS when sending the event. The |
|
| No | Whether or not the webhook should be active. |
|
| No | The list of events to activate on. If no events are given, then the webhook will activate on all events. |
This will update the webhook by the given :id
, for the given namespace. This requires the namespace:write
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| Yes | The URL to send the event payload to. |
|
| No | The secret to sign the event payload with. |
|
| No | Whether or not to use TLS when sending the event. The |
|
| No | Whether or not the webhook should be active. |
|
| No | The list of events to activate on. If no events are given, then the webhook will activate on all events. |
This will update the given namespace. This requires the namespace:write
permission.
NAME | TYPE | REQUIRED | DESCRIPTION |
---|---|---|---|
|
| No | The new description for the namespace. |
|
| No | The new visibility level for the namespace, will be one of:
This will default to |
Returns the updated namespace.
This will delete the given namespace. This requires the namespace:delete
permission.
This returns no content in the response body.