Skip to content
forgit api docs

Delete a group issue board

DELETE
/api/v4/groups/{id}/boards/{board_id}

Deletes a specified group issue board.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

The ID of a group

board_id
required
integer

The ID of a board

Responses

Section titled “ Responses ”

204

Section titled “ 204 ”

No Content

Media type application/json
object
id
integer format: int64
name
string
hide_backlog_list
boolean
hide_closed_list
boolean
project
object
id
integer format: int64
description
string
name
string
name_with_namespace
string
path
string
path_with_namespace
string
created_at
string format: date-time
default_branch
string
tag_list
Array<string>
topics
Array<string>
ssh_url_to_repo
string
http_url_to_repo
string
web_url
string
readme_url
string
forks_count
integer
license_url
string
license
object
key
string
name
string
nickname
string
html_url
string
source_url
string
avatar_url
string
star_count
integer
last_activity_at
string format: date-time
visibility
string
namespace
object
id
integer format: int64
name
string
path
string
kind
string
full_path
string
parent_id
integer format: int64
avatar_url
string
web_url
string
custom_attributes
object
key
string
value
string
repository_storage
string
lists
Array<object>
object
id
integer format: int64
label
object
id
integer format: int64
name
string
description
string
text_color
string
description_html
string
color
string
archived
boolean
position
integer
milestone
object
id
integer format: int64
iid
integer format: int64
project_id
integer format: int64
group_id
string
title
string
description
string
state
string
created_at
string
updated_at
string
due_date
string
start_date
string
expired
boolean
web_url
string
iteration
object
id
integer format: int64
iid
integer
sequence
integer
group_id
integer format: int64
title
string
description
string
state
integer
created_at
string format: date-time
updated_at
string format: date-time
start_date
string format: date
due_date
string format: date
web_url
string
assignee
object
id
integer format: int64
username
string
public_email
string
name
string
max_issue_count
integer
max_issue_weight
integer
limit_metric
string
group
object
id
integer format: int64
web_url
string
name
string
milestone
object
assignee
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
labels
object
id
integer format: int64
name
string
description
string
text_color
string
description_html
string
color
string
archived
boolean
weight
integer
Example 
{
  "id": 1,
  "name": "Development",
  "hide_backlog_list": false,
  "hide_closed_list": false,
  "project": {
    "id": 1,
    "description": "desc",
    "name": "project1",
    "name_with_namespace": "John Doe / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z",
    "default_branch": "main",
    "tag_list": [
      "tag"
    ],
    "topics": [
      "topic"
    ],
    "ssh_url_to_repo": "git@gitlab.example.com:gitlab/gitlab.git",
    "http_url_to_repo": "https://gitlab.example.com/gitlab/gitlab.git",
    "web_url": "https://gitlab.example.com/gitlab/gitlab",
    "readme_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/README.md",
    "forks_count": 1,
    "license_url": "https://gitlab.example.com/gitlab/gitlab/blob/master/LICENCE",
    "license": {
      "key": "gpl-3.0",
      "name": "GNU General Public License v3.0",
      "nickname": "GNU GPLv3",
      "html_url": "http://choosealicense.com/licenses/gpl-3.0"
    },
    "avatar_url": "http://example.com/uploads/project/avatar/3/uploads/avatar.png",
    "star_count": 1,
    "last_activity_at": "2013-09-30T13:46:02Z",
    "visibility": "public",
    "namespace": {
      "id": 2,
      "name": "project",
      "path": "my_project",
      "kind": "project",
      "full_path": "group/my_project",
      "parent_id": 1,
      "avatar_url": "https://example.com/avatar/12345",
      "web_url": "https://example.com/group/my_project"
    },
    "custom_attributes": {
      "key": "foo",
      "value": "bar"
    },
    "repository_storage": "default"
  },
  "lists": [
    {
      "id": 1,
      "label": {
        "id": 1,
        "name": "bug",
        "description": "Bug reported by user",
        "text_color": "#FFFFFF",
        "description_html": "<p>Bug reported by user</p>",
        "color": "#FF0000",
        "archived": false
      },
      "position": 1,
      "iteration": {
        "id": 1,
        "iid": 1,
        "sequence": 1,
        "group_id": 1,
        "title": "Iteration I",
        "description": "Iteration description",
        "state": 1,
        "created_at": "2022-01-31T15:10:45.080Z",
        "updated_at": "2022-01-31T15:10:45.080Z",
        "start_date": "2022-01-01",
        "due_date": "2022-01-31",
        "web_url": "https://gitlab.example.com/groups/gitlab-org/-/iterations/1"
      },
      "assignee": {
        "id": 1,
        "username": "admin",
        "public_email": "john@example.com",
        "name": "Administrator"
      },
      "max_issue_count": 0,
      "max_issue_weight": 0,
      "limit_metric": "issue_count"
    }
  ],
  "group": {
    "web_url": "http://gitlab.example.com/groups/diaspora",
    "name": "Diaspora"
  },
  "assignee": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "labels": {
    "id": 1,
    "name": "bug",
    "description": "Bug reported by user",
    "text_color": "#FFFFFF",
    "description_html": "<p>Bug reported by user</p>",
    "color": "#FF0000",
    "archived": false
  },
  "weight": 0
}

400

Section titled “ 400 ”

Bad Request

404

Section titled “ 404 ”

Not Found