Create a new epic

POST

/api/v4/groups/{id}/(-/)epics

• GitLab REST API

Creates a new epic

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

string

The ID of a group

Request Body ^required

Media type application/json

object

title

required

The title of an epic

string

nullable

Example

My Epic

description

The description of an epic

string

nullable

Example

Epic description

color

The color of an epic

string

nullable

Example

#1068bf

confidential

Indicates if the epic is confidential

boolean

nullable

created_at

Date time when the epic was created. Available only for admins and project owners

string format: date-time

nullable

Example

2016-03-11T03:45:40Z

start_date

Deprecated: use start_date_fixed instead

string

nullable

Example

2018-07-31

start_date_fixed

The start date of an epic

string

nullable

Example

2018-07-31

start_date_is_fixed

Indicates start date should be sourced from start_date_fixed field not the issue milestones

boolean

nullable

end_date

Deprecated: use due_date_fixed instead

string

nullable

Example

2019-08-11

due_date_fixed

The due date of an epic

string

nullable

Example

2019-08-11

due_date_is_fixed

Indicates due date should be sourced from due_date_fixed field not the issue milestones

boolean

nullable

labels

Comma-separated list of label names

Array<string>

nullable

parent_id

The ID of a parent epic

integer

nullable

Example

12

Responses

201

Created

Media type application/json

object

id

integer format: int64

work_item_id

integer

iid

integer

color

string

text_color

string

group_id

integer format: int64

parent_id

integer format: int64

parent_iid

integer

imported

boolean

imported_from

string

title

string

description

string

confidential

boolean

author

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

start_date

string format: date-time

start_date_is_fixed

boolean

start_date_fixed

string format: date-time

start_date_from_inherited_source

string format: date-time

start_date_from_milestones

string format: date-time

end_date

string format: date-time

due_date

string format: date-time

due_date_is_fixed

boolean

due_date_fixed

string format: date-time

due_date_from_inherited_source

string format: date-time

due_date_from_milestones

string format: date-time

state

string

web_edit_url

string

web_url

string

references

Array<object>

object

reference

string

created_at

string format: date-time

updated_at

string format: date-time

closed_at

string format: date-time

labels

Array<string>

upvotes

integer

downvotes

integer

subscribed

boolean

_links

object

Example

{
  "id": 123,
  "work_item_id": 123,
  "iid": 123,
  "color": "#1068bf",
  "text_color": "#1068bf",
  "group_id": 17,
  "parent_id": 12,
  "parent_iid": 19,
  "imported": false,
  "imported_from": "github",
  "title": "My Epic",
  "description": "Epic description",
  "confidential": false,
  "author": {
    "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"
  },
  "start_date": "2022-01-31T15:10:45.080Z",
  "start_date_is_fixed": true,
  "start_date_fixed": "2022-01-31T15:10:45.080Z",
  "start_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
  "start_date_from_milestones": "2022-01-31T15:10:45.080Z",
  "end_date": "2022-01-31T15:10:45.080Z",
  "due_date": "2022-01-31T15:10:45.080Z",
  "due_date_is_fixed": true,
  "due_date_fixed": "2022-01-31T15:10:45.080Z",
  "due_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
  "due_date_from_milestones": "2022-01-31T15:10:45.080Z",
  "state": "opened",
  "web_edit_url": "http://gitlab.example.com/groups/test/-/epics/4/edit",
  "web_url": "http://gitlab.example.com/groups/test/-/epics/4",
  "reference": "&1",
  "created_at": "2022-01-31T15:10:45.080Z",
  "updated_at": "2022-01-31T15:10:45.080Z",
  "closed_at": "2022-01-31T15:10:45.080Z",
  "upvotes": 4,
  "downvotes": 3,
  "subscribed": true
}

400

Bad request

403

Forbidden

404

Not found

429

Too many requests